Skip to main content
GET
/
api
/
agents
/
{agent_id}
Get Agent
curl --request GET \
  --url https://{organization_id}.platform.barndoor.ai/api/agents/{agent_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "application_directory_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "application_directory": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "description": "<string>",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "public": true,
    "dcr": true,
    "post_login_success": true,
    "callbacks": [
      "<string>"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

JWT token obtained through Barndoor's OAuth 2.0 authorization-code flow with PKCE.

The token should be included in the Authorization header: Authorization: Bearer <your-jwt-token>

Use the Barndoor SDK's loginInteractive() function to obtain tokens automatically.

Path Parameters

​
agent_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
organization_id
string<uuid>
required
​
application_directory_id
string<uuid>
required
​
application_directory
AgentDirectoryBase · object
required
​
agent_type
enum<string>
required
read-only

Determine agent type based on application directory properties.

Available options:
internal,
external