Appearance

API reference

Agents

Create, search, run, and manage the agents that execute your sports workflows.

This reference covers a selected set of supported Agent operations. Additional platform capabilities may not be available through the public API.

Create Agent​

Create a new agent and define its configurations.

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Request Body​

application/json

Unique identifier for the agent

Display title of the agent

Detailed description of the agent's purpose

Configuration settings for the agent

Array of workflow definitions

Current status of the agent

Valid values"active""inactive"
Default"active"

Responses​

Agent created successfully

application/json

Operation status

API playground
Build & test
POST/agent

Playground​

Base URL
Authorization
Request body
Ready when you are

Send a request to see the response here.

Execute Agent by ID​

Execute an agent using its unique identifier.

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Parameters​

Path Parameters

id*

Unique ID of the agent to execute

Type
string
Required

Request Body​

application/json

Configuration options for the execution

Input parameters for the agent execution

Additional context data for the agent execution

Responses​

Agent execution result or status

application/json

Unique identifier for the execution

Status of the execution

Valid values"scheduled""completed""failed"

Informational message about the execution

The result of the agent execution (if immediate)

API playground
Build & test
POST/agent/executor/id/{id}

Playground​

Base URL
Authorization
Variables
Key
Value
Request body
Ready when you are

Send a request to see the response here.

Execute Agent by Name​

Execute an agent using its unique name

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Parameters​

Path Parameters

name*

Unique name of the agent to execute

Type
string
Required

Request Body​

application/json

Configuration options for the execution

Input parameters for the agent execution

Additional context data for the agent execution

Responses​

Agent execution result or status

application/json

Unique identifier for the execution

Status of the execution

Valid values"scheduled""completed""failed"

Informational message about the execution

The result of the agent execution (if immediate)

API playground
Build & test
POST/agent/executor/{name}

Playground​

Base URL
Authorization
Variables
Key
Value
Request body
Ready when you are

Send a request to see the response here.

Delete Agent​

Delete an agent by its ID.

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Parameters​

Path Parameters

id*

Unique ID of the agent to delete

Type
string
Required

Responses​

Agent deleted successfully

application/json

Success message

Operation status

API playground
Build & test
DELETE/agent/{id}

Playground​

Base URL
Authorization
Variables
Key
Value
Ready when you are

Send a request to see the response here.

Update Agent​

Update an existing agent by its ID.

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Parameters​

Path Parameters

id*

Unique ID of the agent to update

Type
string
Required

Request Body​

application/json

Updated display title of the agent

Updated description of the agent's purpose

Updated status of the agent

Valid values"active""inactive"

Updated configuration settings for the agent

Updated list of workflows associated with the agent

Responses​

Agent updated successfully

application/json

Success message

Operation status

API playground
Build & test
PUT/agent/{id}

Playground​

Base URL
Authorization
Variables
Key
Value
Request body
Ready when you are

Send a request to see the response here.

Get Agent by ID​

Retrieve an agent by its unique ID.

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Parameters​

Path Parameters

id*

Unique ID of the agent

Type
string
Required

Responses​

Agent details

application/json

Operation status

API playground
Build & test
GET/agent/id/{id}

Playground​

Base URL
Authorization
Variables
Key
Value
Ready when you are

Send a request to see the response here.

Search Agents​

Search for an agent using sort, filter and pagination.

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Request Body​

application/json

Query filters object

Default{}

Array containing field name and sort direction

Default"_id"-1

Page number (starts from 1)

Default1

Number of items per page

Default10

Responses​

Successful operation

application/json

Operation status

Total number of documents matching the query

API playground
Build & test
POST/agent/search

Playground​

Base URL
Authorization
Request body
Ready when you are

Send a request to see the response here.

Get Agent by Name​

Retrieve an agent by its unique name.

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Parameters​

Path Parameters

name*

Unique name of the agent

Type
string
Required

Responses​

Agent details

application/json

Operation status

API playground
Build & test
GET/agent/{name}

Playground​

Base URL
Authorization
Variables
Key
Value
Ready when you are

Send a request to see the response here.

© 2026 Machina Sports · machina.gg