toolCalls.get

GET

/v1/chats/{chatId}/tool-calls/{id}

const url = 'https://example.com/v1/chats/example/tool-calls/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/chats/example/tool-calls/example \
  --header 'Authorization: Bearer <token>'

Authorizations

token
session

Parameters

Path Parameters

chatId

required

string

>= 1 characters

required

string

>= 1 characters <= 128 characters

Responses

200

Success

application/json

Any of:

object
object

object

required

string

>= 1 characters <= 128 characters

executionId

required

string

>= 1 characters <= 128 characters

parentExecutionId

required

string

>= 1 characters <= 128 characters

position

required

object

chat

required

string

turn

required

string

item

required

string

step

required

integer

<= 9007199254740991

callId

required

string

tool

required

string

status

required

string

Allowed values: queued running waiting cancelling completed failed cancelled interrupted outcome_unknown

detached

required

boolean

startedAt

required

number

deadline

required

number

failure

required

Any of:

object
null

object

errorId

required

string

>= 1 characters <= 128 characters

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

output

required

Any of:

unknown
null

Example

{
  "status": "queued",
  "failure": {
    "category": "invalid"
  }
}

400

OrganizationRequired

application/json

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "OrganizationRequired"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionForbidden

Example

{
  "_tag": "ExecutionForbidden"
}

404

ExecutionNotFound | ToolCallNotFound | ChatNotFound

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionNotFound

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionNotFound"
}

409

ExecutionConflict | ExecutionKeyConflict | ChatConflict | @nmnmcc/ability/Authorizer/Pending

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionConflict

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionConflict"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ExecutionUnavailable | ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionUnavailable

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionUnavailable"
}