Skip to main content
GET
/
agents
/
{agent_id}
Retrieve an agent
curl --request GET \
  --url https://api.deck.co/v2/agents/{agent_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "<string>",
  "name": "<string>",
  "description": "<string>",
  "tasks": [
    {
      "id": "<string>",
      "object": "<string>",
      "name": "<string>",
      "status": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "request_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Secret key (sk_live_...)

Path Parameters

​
agent_id
string
required

Unique identifier for the agent (prefixed with agt_).

Response

OK

An agent object. Agents organize related tasks under a single use case.

​
id
string
required

Unique identifier for the agent, prefixed with agt_.

​
object
string
required

Always agent.

​
name
string
required

Display name for the agent.

​
description
null | string
required

Description of the agent's purpose.

​
tasks
object[]
required

Tasks associated with this agent.

​
created_at
string<date-time>
required

ISO 8601 timestamp of when the resource was created.

​
updated_at
string<date-time>
required

ISO 8601 timestamp of when the resource was last updated.

​
request_id
string
required

Unique identifier for the API request. Include this when contacting support.