Skip to main content
GET
Retrieves details of an existing agent
Retrieves the current settings and details available for an existing agent in your workspace. The endpoint returns the agent’s active (published) version. If the agent has never been published, it returns the current draft instead.

Before You Start

  • API key scope: Requires an API key with the Agent API scope and access to the agent you want to retrieve.
  • Legacy Assistants API: This is the new Agents API with native Vercel AI SDK compatibility. If you’re using the legacy Assistants API, see the migration guide.

Base URL

Dedicated deploymentsReplace api.langdock.com with <your-deployment-url>/api/public in all requests.

Parameters

Examples

Basic Retrieval

Validation Rules

The API enforces the following validation rules:
  • Agent access - Your API key must have access to the agent
  • Workspace match - Agent must belong to the same workspace as your API key

Response Format

Success Response (200 OK)

Error Handling

Langdock intentionally blocks browser-origin requests to protect your API key and ensure your applications remain secure. For more information, please see our guide on API Key Best Practices.

Authorizations

Authorization
string
header
required

API key as Bearer token. Format "Bearer YOUR_API_KEY"

Query Parameters

agentId
string<uuid>
required

Response

200 - application/json

Agent retrieved successfully

status
string
required
agent
object
required