Skip to main content
GET
Get Agent Version
Read only Get Agent Version uses your workspace API key. Returns one version of an agent owned by your workspace. Use this to inspect a published or draft configuration.

Before you begin

Use a server-side API key for the intended workspace. Replace each path placeholder with an existing resource ID or version number from that workspace.

Get Agent Version request

The request panel lists supported query parameters and body fields. For a request body, the example below supplies the required fields. Replace sample values with your own inputs.

Verify the result

Expect HTTP 200. Read the data property in the success envelope; the response panel documents its fields.

Retry safety

This operation does not modify workspace resources. Retry after a transient connection failure.

Errors and recovery

  • 401: Missing, expired, or invalid API key.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agentId
string
required
versionNumber
string
required

Response

success
enum<boolean>
required
Available options:
true
error
enum<boolean>
required
Available options:
false
statusCode
integer
required
Example:

200

message
string
required
Example:

"Success"

data
object
required
timestamp
string<date-time>
required