Skip to main content
GET
/
api
/
v2
/
agents
/
get
Get Agent
curl --request GET \
  --url https://app.octavehq.com/api/v2/agents/get \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": {
    "oId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "costToRun": 123,
    "data": "<unknown>",
    "warnings": [
      "<string>"
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

api_key
string
header
required

Query Parameters

oId
string
required

Agent OId

Response

Agent data

_metadata
object
required
data
object
required