How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Flatfile subpackage_agents API

The subpackage_agents API from Flatfile — 10 operation(s) for subpackage_agents.

Flatfile subpackage_agents API is one of 32 APIs that Flatfile publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 13 operations across 10 paths, and defines 45 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.x.flatfile.com/v1.

13 operations 10 paths 45 schemas 2 DELETE9 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.x.flatfile.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Flatfile subpackage_agents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (default).

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 2 DELETE, 9 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

subpackage_agents 13
GET
/agents
List agents
list 7 params → 200
POST
/agents
Create an agent
create 3 params body → 200400
GET
/agents/{agentId}
Get an agent
get 4 params → 200400404
DELETE
/agents/{agentId}
Delete an agent
delete 4 params → 200400404
GET
/agents/{agentId}/versions
List agent versions for an agent
list-versions 3 params → 200400404
GET
/agents/{agentId}/versions/{agentVersionId}/revert
Revert to a specific agent version
revert 4 params → 200400404
GET
/agents/{agentId}/roles
List Agent Roles
list-agent-roles 3 params → 200400403404
POST
/agents/{agentId}/roles
Assign Role to Agent
assign-agent-role 3 params body → 200400403404
DELETE
/agents/{agentId}/roles/{actorRoleId}
Remove Role from Agent
delete-agent-role 4 params → 200400403404
GET
/agents/{agentId}/logs
Get logs for an agent
get-agent-logs 4 params → 200400404
GET
/agents/log/{eventId}
Get an agent log
get-agent-log 4 params → 200400404
GET
/agents/logs
Get all agent logs in your environment
get-environment-agent-logs 7 params → 200400404
GET
/agents/executions
Get all executions in your environment
get-environment-agent-executions 8 params → 200400404

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are type_agents:Agent (19 properties), type_agents:AgentVersion (18 properties), type_agents:AgentLog (17 properties), type_agents:AgentConfig (12 properties). Each schema is shown below with its type and property counts.

type_commons:EventId
string
Event ID
type_commons:Success
object
Informs whether or not a request was successful
1 property
type_agents:Compiler
string
The compiler of the agent
type_commons:PageSize
integer
Number of logs to return in a page (default 20)
type_agents:AgentVersionResponse
object
1 property
type_agents:Execution
object
An execution of an agent
10 properties 6 required
type_roles:ActorRoleResponse
object
6 properties 6 required
type_commons:SuccessQueryParameter
boolean
Boolean
type_events:EventTopic
string
The topic of the event
type_agents:TemplateOptions
The options for a templated agent.
type_commons:EnvironmentId
string
Environment ID
type_commons:ActorRoleId
string
Actor Role ID
type_commons:Error
object
2 properties 1 required
type_agents:AgentVersion
object
18 properties 6 required
type_commons:RoleId
string
Role ID
type_commons:AgentLogId
string
Agent Log ID
type_commons:PageNumber
integer
Based on pageSize, which page of records to return
type_agents:GetExecutionsResponse
object
2 properties 1 required
type_commons:SuccessData
object
1 property 1 required
type_agents:AgentLog
object
A log of an agent execution
17 properties 6 required
type_agents:GetAgentLogsResponse
object
2 properties
type_agents:AutomapOptions
object
3 properties 3 required
type_agents:DetailedAgentLog
object
A log of an agent execution
8 properties 7 required
type_agents:AgentResponse
object
1 property
type_agents:GetDetailedAgentLogsResponse
object
2 properties 1 required
type_agents:ListAgentVersionsResponse
object
1 property
type_commons:Pagination
object
pagination info
3 properties 3 required
type_commons:GuestId
string
Guest ID
type_roles:AssignActorRoleRequest
object
2 properties 2 required
type_commons:Errors
object
1 property 1 required
type_agents:AgentConfig
object
Properties used to create a new agent
12 properties
type_commons:SpaceId
string
Space ID
type_commons:AgentId
string
Agent ID
type_agents:Agent
object
19 properties 5 required
type_roles:AssignRoleResponse
object
1 property 1 required
type_commons:AgentVersionId
string
Agent version ID
type_roles:AssignRoleResponseData
object
6 properties 6 required
type_agents:GetDetailedAgentLogResponse
object
1 property 1 required
type_commons:UserId
string
User ID
type_agents:AgentTemplateEnum
string
The template of the agent
type_commons:AccountId
string
Account ID
type_roles:ListActorRolesResponse
object
1 property 1 required
type_roles:ResourceIdUnion
type_commons:ActorIdUnion
type_agents:ListAgentsResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

flatfile-subpackage-agents-api-openapi.yml Raw ↑

Other APIs Flatfile publishes across the network.

Flatfile subpackage_accounts API
Flatfile subpackage_actions API
Flatfile subpackage_agent-exports API
Flatfile subpackage_apps API
Flatfile subpackage_assistant API
Flatfile subpackage_auth API
Flatfile subpackage_canvas-areas API
Flatfile subpackage_commits API
Flatfile subpackage_data-clips API
Flatfile subpackage_data-retention-policies API
Flatfile subpackage_documents API
Flatfile subpackage_entitlements API
Where this information came from

This is an independent, third-party profile of Flatfile subpackage_agents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.