Skip to main content

Creating artifacts

You can create an artifact, a saved output from your work in Revelry Ai, four ways: ask for one in chat, save a single chat message, call the API, or run a Workflow.

Ways to create artifacts​

1. Ask in chat​

During a chat, Revelry Ai creates and updates artifacts with its artifact tools, so you don't need to export anything by hand. The tools come in two variants, and it picks whichever fits the task:

  • The direct tools write the artifact right away from content already in the conversation. This is the fast path.
  • The sub-agent tools hand the work to a sub-agent with tools like web and document search. They're used when the content needs research or several steps the chat hasn't done yet. The chat waits for the sub-agent, so the artifact is finished by the time the chat replies.

To create one in chat:

  1. Start a chat conversation and describe what you need
  2. It gathers information with its tools
  3. It creates the artifact, directly when the content is ready or through a sub-agent when it needs to research first
  4. You can ask it to change the artifact, and it updates it with the same tools

It chooses the category, type, content, and creation path from the conversation. Creating and updating artifacts requires the Manage Content permission.

The Artifacts built-in tool has to be on for any of this to work. It's on by default. If you turn off the Artifacts toggle under Built-in Tools in the Chat Tools menu, artifacts can't be created or found in that chat. That can suit a chat that's only for research or analysis.

Learn more: Artifact tools

2. Manual chat export​

Use this to save one chat message exactly as it is.

Each message has a Save as artifact icon. Clicking it opens the Save Artifact dialog, and when you click the Save Artifact button there, the message is saved word for word.

To save one message:

  1. Have a conversation in chat
  2. Click the Save as artifact icon on the message you want to keep
  3. In the Saving to field, click Change to choose where to save it, and pick an Artifact Type from the dropdown if it's there
  4. Click the Save Artifact button

Learn more: Exporting from Chat

3. API generation (for developers)​

Use the API to create artifacts from your own applications and integrations.

The API creates artifacts without a chat. It can stream the response or return it when the artifact is done.

To create one through the API:

  1. Send a Skill and its inputs to the API
  2. The API runs the Skill and creates the artifact
  3. The API sends back the artifact

Learn more: API Documentation

4. Workflows​

Use a Workflow for work with several steps that you repeat the same way.

A Workflow is a set of steps, each running a Skill. You start a run from the app or through the API, and steps can create artifacts with the same tools chat uses.

To create artifacts with a Workflow:

  1. Build the Workflow from steps, each running a Skill
  2. Start a run from the app or through the Workflows API
  3. A step starts once the steps it depends on finish. Steps can create artifacts
  4. The artifacts appear in your project

Learn more: Workflows

Choosing the right method​

FactorAsk in chatSave one messageAPIWorkflows
InterfaceWeb UI (chat)Web UI (chat)ProgrammaticWorkflow Builder
Who creates itThe artifact toolsYou save one messageYour codeWorkflow steps
IterationConversationalConversationalOne-shotStructured
Use it forCreating or updating artifacts as you talkSaving one message as it isYour own apps and integrationsWork with repeated steps

If you're not sure, start in chat, where artifacts get created as part of the conversation.

What all methods have in common​

However an artifact is created, it:

  • Is saved to your project
  • Can be opened from its project
  • Can be edited, shared, and exported, unless it's a file-based artifact, which you can only download
  • Shows up in artifact search, by name and content, including from chat
  • Isn't added to Knowledge as a document unless you save it there

Artifacts are searchable on their own, so chat can find them with no extra step. The main reason to save an artifact to Knowledge is to add it to a collection. Collections hold documents, so the artifact has to be saved as a document first.

Learn more: Saving to Knowledge | Documents vs. Artifacts

After creation​

Once created, an artifact can be:

  • Viewed
  • Edited directly
  • Saved to Knowledge as a document, so it can be added to collections and reused as context
  • Shared with a link
  • Copied, downloaded as a PDF, or sent to Google Drive once you've connected your Google account
  • Sent to GitHub as an issue once your organization adds a GitHub repository as a data source

A file-based artifact, such as a spreadsheet, opens to a Download File button. You can't edit, share, copy, or save it to Knowledge, and it doesn't keep a version history.

Learn more: Managing Artifacts | Saving to Knowledge

Artifact types​

However you create an artifact, you can classify it with an Artifact Type (its format or purpose) and a Category (where it's filed).

You can choose from the categories assigned to the project that one of your groups can access.

Learn more: Artifact Types

Best practices​

Let Revelry Ai create artifacts​

In most cases, it creates artifacts for you during chat. Describe what you need and it handles the rest.

Use manual export for precision​

When you want to save one specific message exactly as it is, use manual export from chat.

Use the API for integration​

When you need programmatic generation for custom applications or integrations, use the API.

Use Workflows for structured processes​

When the work has several steps you repeat the same way, set up a Workflow.

Next steps​