Skip to main content

Retrieve

GET 
/agents/:agent_id

Retrieve a specific agent in the AgentStation platform.

Request​

Path Parameters

    agent_id uidrequired

    The UID associated to an Agent. Learn more

Responses​

Successfully retrieved the agent.

Schema

    id uidrequired

    The UID associated to an Agent. Learn more

    name stringrequired

    The name of the agent.

    description stringrequired

    A brief description of the agent.

    type AgentType (string)required

    Possible values: [human, ai]

    The type of agent.

    workspace

    object

    required

    id uidrequired

    The UID associated to a Workspace. Learn more

    status WorkspaceStatus (string)required

    Possible values: [active, archived]

    The status of the Workspace.

    files

    object

    object string

    Possible values: [list]

    data

    object[]

  • Array [

    • id uuidrequired

    The UUID associated to a file.

    name stringrequired

    The name of the file.

    url urirequired

    URL to download the file contents.

    size integerrequired

    The size of the file in bytes.

    createdAt date-timerequired

    The creation time of the file.

  • ]

    • logs

    object

    object string

    Possible values: [list]

    data

    object[]

  • Array [

    • id uuidrequired

    The UUID associated to a log.

    type stringrequired

    The type of log.

    level LogLevel (string)required

    Possible values: [debug, info, warning, error]

    The log level.

    url uri

    URL to download the file contents.

    createdAt date-timerequired

    The creation time of the log.

  • ]

    • createdAt date-timerequired

    The creation time of the Workspace.

    createdAt date-timerequired

    The creation time of the agent.

Loading...