Agents
List Agents
GET /v1/workspaces/{workspaceId}/agents
Lists all agents within a specified workspace. This endpoint supports pagination to retrieve a subset of agents based on the query parameters provided.
Parameters
NAME
TYPE
IN
DESCRIPTION
DEFAULT VALUE
workspaceId
int32
path
The workspace ID.
None
take
int32
query
The number of agents to return in the response.
20
skip
int32
query
The number of agents to skip before returning results. Used for pagination.
0
Responses
Code
Message
Action
200
OK
Returns a list of agents in the workspace.
Response Example:
1
2
3
4
5
6
7
8
9
10 { "data" : [ { "id" : 0 , "name" : "string" , "key" : "string" } ] , "hasMore" : true }
Request Example
1
2 curl -X GET "https://api.skyvia.com/v1/workspaces/123/agents?take=20&skip=0" \ -H "Authorization: <access_token>"
Get Agent Details
GET /v1/workspaces/{workspaceId}/agents/{agentId}
Retrieves the details of a specific agent in a workspace, identified by agentId.
Parameters
NAME
TYPE
IN
DESCRIPTION
workspaceId
int32
path
The workspace ID.
agentId
int32
path
The agent ID to retrieve details for.
Responses
Code
Message
Action
200
OK
Returns the details of the specified agent.
Response Example:
1
2
3
4
5 { "id" : 0 , "name" : "string" , "key" : "string" }
Request Example
1
2 curl -X GET "https://api.skyvia.com/v1/workspaces/123/agents/456" \ -H "Authorization: <access_token>"
Test Agent
POST /v1/workspaces/{workspaceId}/agents/{agentId}/test
Tests the specified agent in a workspace to ensure it's functioning.
Parameters
NAME
TYPE
IN
DESCRIPTION
workspaceId
int32
path
The workspace ID.
agentId
int32
path
The agent ID to test.
Responses
Code
Message
Action
200
OK
Returns the result of the agent test.
Response Example:
1
2
3
4 { "message" : "string" , "refresh" : true }
Request Example
1
2 curl -X POST "https://api.skyvia.com/v1/workspaces/123/agents/456/test" \ -H "Authorization: <access_token>"
Last updated: October 14, 2024
×
What is the reason for your feedback?