Skip to main content
GET
/
agents
/
{identifier}
Get agent
curl --request GET \
  --url https://api.flipsidecrypto.xyz/public/v3/agents/{identifier} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "kind": "chat",
  "status": "draft",
  "handlerType": "database",
  "systemPrompt": "<string>",
  "tools": [
    {
      "name": "<string>",
      "config": {}
    }
  ],
  "maxTurns": 25,
  "metadata": {},
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationSlug": "<string>",
  "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "subAgents": [],
  "skills": [],
  "inputSchema": {},
  "outputSchema": {},
  "userAgent": "web",
  "lastUsedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
identifier
string
required

Agent UUID or slug

Minimum string length: 1

Response

Agent config details

​
id
string<uuid>
required
​
name
string
required
Required string length: 1 - 255
Pattern: ^[a-z0-9_]+$
​
description
string | null
required
Maximum string length: 1000
​
kind
enum<string>
required
Available options:
chat,
sub
​
status
enum<string>
required
Available options:
draft,
active,
archived
​
handlerType
enum<string>
required
Available options:
database,
code
​
systemPrompt
string
required
​
tools
object[] | null
required
​
maxTurns
integer
required
Required range: 1 <= x <= 50
​
metadata
object
required
​
organizationId
string<uuid>
required

Organization ID that owns this agent.

​
organizationSlug
string
required

Organization slug that owns this agent. Derived from the organization relation.

​
createdById
string<uuid>
required

User ID who created this agent.

​
updatedById
string<uuid>
required

User ID who last updated this agent.

​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
subAgents
string[] | null
Required string length: 1 - 255
Pattern: ^([a-z0-9_-]+\/)?[a-z0-9_]+$
​
skills
string[] | null
Minimum string length: 1
​
inputSchema
object
​
outputSchema
object
​
userAgent
enum<string> | null
Available options:
web,
cli,
internal-cli,
api,
slack,
discord,
telegram,
schedule,
unknown,
null
​
lastUsedAt
string<date-time> | null