Flatfile subpackage_agents API
The subpackage_agents API from Flatfile — 10 operation(s) for subpackage_agents.
The subpackage_agents API from Flatfile — 10 operation(s) for subpackage_agents.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/flatfile-subpackage-agents-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Reference subpackage_accounts Subpackage Agents API
version: 1.0.0
servers:
- url: https://api.x.flatfile.com/v1
tags:
- name: subpackage_agents
paths:
/agents:
get:
operationId: list
summary: List agents
tags:
- subpackage_agents
parameters:
- name: environmentId
in: query
required: true
schema:
$ref: '#/components/schemas/type_commons_EnvironmentId'
- name: isSystem
in: query
required: false
schema:
type: boolean
- name: search
in: query
required: false
schema:
type: string
- name: pageSize
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons_PageSize'
- name: pageNumber
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons_PageNumber'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents_ListAgentsResponse'
post:
operationId: create
summary: Create an agent
tags:
- subpackage_agents
parameters:
- name: environmentId
in: query
required: true
schema:
$ref: '#/components/schemas/type_commons_EnvironmentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents_AgentResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents_AgentConfig'
/agents/{agentId}:
get:
operationId: get
summary: Get an agent
tags:
- subpackage_agents
parameters:
- name: agentId
in: path
required: true
schema:
$ref: '#/components/schemas/type_commons_AgentId'
- name: environmentId
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons_EnvironmentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents_AgentResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
delete:
operationId: delete
summary: Delete an agent
description: Deletes a single agent
tags:
- subpackage_agents
parameters:
- name: agentId
in: path
required: true
schema:
$ref: '#/components/schemas/type_commons_AgentId'
- name: environmentId
in: query
description: This environment variable is no longer needed or used
required: false
schema:
$ref: '#/components/schemas/type_commons_EnvironmentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Success'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
/agents/{agentId}/versions:
get:
operationId: list-versions
summary: List agent versions for an agent
tags:
- subpackage_agents
parameters:
- name: agentId
in: path
required: true
schema:
$ref: '#/components/schemas/type_commons_AgentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents_ListAgentVersionsResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
/agents/{agentId}/versions/{agentVersionId}/revert:
get:
operationId: revert
summary: Revert to a specific agent version
tags:
- subpackage_agents
parameters:
- name: agentId
in: path
required: true
schema:
$ref: '#/components/schemas/type_commons_AgentId'
- name: agentVersionId
in: path
required: true
schema:
$ref: '#/components/schemas/type_commons_AgentVersionId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents_AgentVersionResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
/agents/{agentId}/roles:
get:
operationId: list-agent-roles
summary: List Agent Roles
description: Lists roles assigned to an agent.
tags:
- subpackage_agents
parameters:
- name: agentId
in: path
description: The agent id
required: true
schema:
$ref: '#/components/schemas/type_commons_AgentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_roles_ListActorRolesResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'403':
description: Error response with status 403
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
post:
operationId: assign-agent-role
summary: Assign Role to Agent
description: Assigns a role to a agent.
tags:
- subpackage_agents
parameters:
- name: agentId
in: path
description: The agent id
required: true
schema:
$ref: '#/components/schemas/type_commons_AgentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_roles_AssignRoleResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'403':
description: Error response with status 403
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_roles_AssignActorRoleRequest'
/agents/{agentId}/roles/{actorRoleId}:
delete:
operationId: delete-agent-role
summary: Remove Role from Agent
description: Removes a role from an agent.
tags:
- subpackage_agents
parameters:
- name: agentId
in: path
description: The agent id
required: true
schema:
$ref: '#/components/schemas/type_commons_AgentId'
- name: actorRoleId
in: path
description: The actor role id
required: true
schema:
$ref: '#/components/schemas/type_commons_ActorRoleId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Success'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'403':
description: Error response with status 403
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
/agents/{agentId}/logs:
get:
operationId: get-agent-logs
summary: Get logs for an agent
tags:
- subpackage_agents
parameters:
- name: agentId
in: path
required: true
schema:
$ref: '#/components/schemas/type_commons_AgentId'
- name: environmentId
in: query
required: true
schema:
$ref: '#/components/schemas/type_commons_EnvironmentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents_GetAgentLogsResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
/agents/log/{eventId}:
get:
operationId: get-agent-log
summary: Get an agent log
tags:
- subpackage_agents
parameters:
- name: eventId
in: path
required: true
schema:
$ref: '#/components/schemas/type_commons_EventId'
- name: environmentId
in: query
required: true
schema:
$ref: '#/components/schemas/type_commons_EnvironmentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents_GetDetailedAgentLogResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
/agents/logs:
get:
operationId: get-environment-agent-logs
summary: Get all agent logs in your environment
tags:
- subpackage_agents
parameters:
- name: environmentId
in: query
required: true
schema:
$ref: '#/components/schemas/type_commons_EnvironmentId'
- name: spaceId
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons_SpaceId'
- name: success
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons_SuccessQueryParameter'
- name: pageSize
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons_PageSize'
- name: pageNumber
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons_PageNumber'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents_GetDetailedAgentLogsResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
/agents/executions:
get:
operationId: get-environment-agent-executions
summary: Get all executions in your environment
tags:
- subpackage_agents
parameters:
- name: environmentId
in: query
required: true
schema:
$ref: '#/components/schemas/type_commons_EnvironmentId'
- name: agentId
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons_AgentId'
- name: spaceId
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons_SpaceId'
- name: success
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons_SuccessQueryParameter'
- name: pageSize
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons_PageSize'
- name: pageNumber
in: query
required: false
schema:
$ref: '#/components/schemas/type_commons_PageNumber'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_agents_GetExecutionsResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
components:
schemas:
type_commons_PageNumber:
type: integer
description: Based on pageSize, which page of records to return
title: PageNumber
type_commons_SpaceId:
type: string
description: Space ID
title: SpaceId
type_commons_Error:
type: object
properties:
key:
type: string
message:
type: string
required:
- message
title: Error
type_roles_ListActorRolesResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/type_roles_ActorRoleResponse'
required:
- data
title: ListActorRolesResponse
type_commons_AgentLogId:
type: string
description: Agent Log ID
title: AgentLogId
type_commons_EventId:
type: string
description: Event ID
title: EventId
type_agents_ListAgentsResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/type_agents_Agent'
pagination:
$ref: '#/components/schemas/type_commons_Pagination'
title: ListAgentsResponse
type_commons_GuestId:
type: string
description: Guest ID
title: GuestId
type_agents_GetDetailedAgentLogResponse:
type: object
properties:
data:
$ref: '#/components/schemas/type_agents_DetailedAgentLog'
required:
- data
title: GetDetailedAgentLogResponse
type_agents_AgentConfig:
type: object
properties:
topics:
type: array
items:
$ref: '#/components/schemas/type_events_EventTopic'
description: The topics the agent should listen for
compiler:
$ref: '#/components/schemas/type_agents_Compiler'
description: The compiler of the agent
source:
type: string
description: The source of the agent
sourceMap:
type: string
description: The source map of the agent
slug:
type: string
description: The slug of the agent
options:
type: object
additionalProperties:
description: Any type
description: This field is deprecated and will be removed in the future. Use the `template` and `templateOptions` fields instead.
template:
$ref: '#/components/schemas/type_agents_AgentTemplateEnum'
description: The template of the agent; Template options are required for templated agents.
templateOptions:
$ref: '#/components/schemas/type_agents_TemplateOptions'
description: The options for a templated agent. Must be provided if `template` is provided.
isSystem:
type: boolean
description: Whether the agent is a system agent. This should be false for all agents created by users.
namespace:
type: string
description: The namespace this agent should be limited to. Right now, this is information only and not used to actually filter agents that run, so you must still specify the namespace filter in the agent code.
packageVersions:
type: object
additionalProperties:
type: string
description: Package versions information for the agent
commitInfo:
type: object
additionalProperties:
description: Any type
description: Commit information for the agent
description: Properties used to create a new agent
title: AgentConfig
type_agents_Compiler:
type: string
enum:
- js
description: The compiler of the agent
title: Compiler
type_agents_Agent:
type: object
properties:
topics:
type: array
items:
$ref: '#/components/schemas/type_events_EventTopic'
description: The topics the agent should listen for
compiler:
$ref: '#/components/schemas/type_agents_Compiler'
description: The compiler of the agent
source:
type: string
description: The source of the agent
sourceMap:
type: string
description: The source map of the agent
slug:
type: string
description: The slug of the agent
options:
type: object
additionalProperties:
description: Any type
description: This field is deprecated and will be removed in the future. Use the `template` and `templateOptions` fields instead.
template:
$ref: '#/components/schemas/type_agents_AgentTemplateEnum'
description: The template of the agent; Template options are required for templated agents.
templateOptions:
$ref: '#/components/schemas/type_agents_TemplateOptions'
description: The options for a templated agent. Must be provided if `template` is provided.
isSystem:
type: boolean
description: Whether the agent is a system agent. This should be false for all agents created by users.
namespace:
type: string
description: The namespace this agent should be limited to. Right now, this is information only and not used to actually filter agents that run, so you must still specify the namespace filter in the agent code.
packageVersions:
type: object
additionalProperties:
type: string
description: Package versions information for the agent
commitInfo:
type: object
additionalProperties:
description: Any type
description: Commit information for the agent
id:
$ref: '#/components/schemas/type_commons_AgentId'
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
accountId:
$ref: '#/components/schemas/type_commons_AccountId'
environmentId:
$ref: '#/components/schemas/type_commons_EnvironmentId'
createdFrom:
$ref: '#/components/schemas/type_commons_AgentId'
description: The agent id of the template that was used to create this agent
lastPropagatedAt:
type: string
format: date-time
description: The last time the agent template configuration was propagated to this agent
required:
- id
- createdAt
- updatedAt
- accountId
- environmentId
title: Agent
type_commons_PageSize:
type: integer
description: Number of logs to return in a page (default 20)
title: PageSize
type_roles_ResourceIdUnion:
oneOf:
- $ref: '#/components/schemas/type_commons_AccountId'
- $ref: '#/components/schemas/type_commons_EnvironmentId'
- $ref: '#/components/schemas/type_commons_SpaceId'
title: ResourceIdUnion
type_commons_AgentVersionId:
type: string
description: Agent version ID
title: AgentVersionId
type_agents_AgentTemplateEnum:
type: string
enum:
- constraints
- autobuild
- autocast
- webhook-egress
- action-listener
- automap
description: The template of the agent
title: AgentTemplateEnum
type_agents_GetAgentLogsResponse:
type: object
properties:
pagination:
$ref: '#/components/schemas/type_commons_Pagination'
data:
type: array
items:
$ref: '#/components/schemas/type_agents_AgentLog'
title: GetAgentLogsResponse
type_agents_AgentVersionResponse:
type: object
properties:
data:
$ref: '#/components/schemas/type_agents_AgentVersion'
title: AgentVersionResponse
type_agents_AgentResponse:
type: object
properties:
data:
$ref: '#/components/schemas/type_agents_Agent'
title: AgentResponse
type_commons_Success:
type: object
properties:
data:
$ref: '#/components/schemas/type_commons_SuccessData'
description: Informs whether or not a request was successful
title: Success
type_commons_SuccessData:
type: object
properties:
success:
type: boolean
required:
- success
title: SuccessData
type_commons_Pagination:
type: object
properties:
currentPage:
type: integer
description: current page of results
pageCount:
type: integer
description: total number of pages of results
totalCount:
type: integer
description: total available results
required:
- currentPage
- pageCount
- totalCount
description: pagination info
title: Pagination
type_roles_ActorRoleResponse:
type: object
properties:
id:
$ref: '#/components/schemas/type_commons_ActorRoleId'
roleId:
$ref: '#/components/schemas/type_commons_RoleId'
actorId:
$ref: '#/components/schemas/type_commons_ActorIdUnion'
resourceId:
$ref: '#/components/schemas/type_roles_ResourceIdUnion'
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
required:
- id
- roleId
- actorId
- resourceId
- createdAt
- updatedAt
title: ActorRoleResponse
type_agents_AutomapOptions:
type: object
properties:
accuracy:
type: string
defaultTargetSheet:
type: string
matchFilename:
type: string
required:
- accuracy
- defaultTargetSheet
- matchFilename
title: AutomapOptions
type_commons_Errors:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/type_commons_Error'
required:
- errors
title: Errors
type_roles_AssignActorRoleRequest:
type: object
properties:
roleId:
$ref: '#/components/schemas/type_commons_RoleId'
resourceId:
$ref: '#/components/schemas/type_roles_ResourceIdUnion'
required:
- roleId
- resourceId
title: AssignActorRoleRequest
type_commons_SuccessQueryParameter:
type: boolean
description: Boolean
title: SuccessQueryParameter
type_commons_AgentId:
type: string
description: Agent ID
title: AgentId
type_agents_DetailedAgentLog:
type: object
properties:
eventId:
$ref: '#/components/schemas/type_commons_EventId'
success:
type: boolean
description: Whether the agent execution was successful
createdAt:
type: string
format: date-time
completedAt:
type: string
format: date-time
duration:
type: integer
description: The duration of the agent execution
topic:
type: string
description: The topics of the agent execution
context:
type: object
additionalProperties:
description: Any type
description: The context of the agent execution
log:
type: string
description: The log of the agent execution
required:
- eventId
- success
- createdAt
- completedAt
- duration
- topic
- context
description: A log of an agent execution
title: DetailedAgentLog
type_agents_GetExecutionsResponse:
type: object
properties:
pagination:
$ref: '#/components/schemas/type_commons_Pagination'
data:
type: array
items:
$ref: '#/components/schemas/type_agents_Execution'
required:
- data
title: GetExecutionsResponse
type_agents_Execution:
type: object
properties:
eventId:
$ref: '#/components/schemas/type_commons_EventId'
success:
type: boolean
description: Whether the agent execution was successful
spaceId:
$ref: '#/components/schemas/type_commons_SpaceId'
description: The space ID associated with this execution
createdAt:
type: string
format: date-time
completedAt:
type: string
format: date-time
duration:
type: integer
description: The duration of the agent execution
requestTime:
type: integer
description: The amount of time the agent spent making http requests
requestCount:
type: integer
description: The number of requests made by the agent
memoryUsage:
type: integer
description: The memory usage of the agent
topic:
type: string
# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flatfile/refs/heads/main/openapi/flatfile-subpackage-agents-api-openapi.yml