Skip to main content
POST
Preview importing an agent export file

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Headers

x-tenant-id
string

Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.

Minimum string length: 1
x-organization-id
string

Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.

Minimum string length: 1

Body

application/json

An agent export file to import into the calling organization, with where each of its references lands.

file
object | null
required
write-only

A recursion.agent-export document as the console's Export writes it, format version 1 or 2. Version 2 carries catalog skills whole, with their bundled files. The file is at most 33554432 bytes.

choices
object
write-only

Where each item of the preview lands, by its key: the id of one of its candidates, or an empty string to leave it out. An item not named here takes its default: its only candidate when it has exactly one, otherwise nothing. A skill item defaults to importing the file's own copy, and a catalog skill item to creating the skill.

name
string
write-only

Name for the new agent. Omit to keep the name in the file.

Maximum string length: 256

Response

OK

importable
boolean
required

Whether an import with the same file and choices would be accepted now.

instructions
object[]
required

The text the new agent follows, in full: its system prompt, rubric, skills and team settings, and its other settings. A file can come from someone else, so this is for a person to read before importing.

items
object[]
required

Every reference with a choice, in file order.

report
object
required
read-only
blockedReason
string

Why it would not, when it would not.