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.2.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.2.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_ActorRoleId
string
Actor Role ID
type_roles_AssignRoleResponseData
object
6 properties 6 required
type_agents_Execution
object
An execution of an agent
10 properties 6 required
type_agents_AutomapOptions
object
3 properties 3 required
type_roles_ActorRoleResponse
object
6 properties 6 required
type_commons_SuccessData
object
1 property 1 required
type_agents_AgentVersion
object
18 properties 6 required
type_agents_AgentVersionResponse
object
1 property
type_agents_AgentLog
object
A log of an agent execution
17 properties 6 required
type_commons_GuestId
string
Guest ID
type_roles_AssignRoleResponse
object
1 property 1 required
type_agents_GetAgentLogsResponse
object
2 properties
type_commons_Success
object
Informs whether or not a request was successful
1 property
type_agents_ListAgentsResponse
object
2 properties
type_agents_DetailedAgentLog
object
A log of an agent execution
8 properties 7 required
type_commons_UserId
string
User ID
type_commons_SuccessQueryParameter
boolean
Boolean
type_agents_GetExecutionsResponse
object
2 properties 1 required
type_agents_Agent
object
19 properties 5 required
type_commons_RoleId
string
Role ID
type_commons_PageNumber
integer
Based on pageSize, which page of records to return
type_commons_AgentId
string
Agent ID
type_commons_PageSize
integer
Number of logs to return in a page (default 20)
type_commons_EventId
string
Event ID
type_commons_AccountId
string
Account ID
type_roles_ResourceIdUnion
type_commons_AgentVersionId
string
Agent version ID
type_commons_EnvironmentId
string
Environment ID
type_roles_AssignActorRoleRequest
object
2 properties 2 required
type_commons_SpaceId
string
Space ID
type_roles_ListActorRolesResponse
object
1 property 1 required
type_commons_Errors
object
1 property 1 required
type_agents_AgentConfig
object
Properties used to create a new agent
12 properties
type_agents_ListAgentVersionsResponse
object
1 property
type_agents_GetDetailedAgentLogsResponse
object
2 properties 1 required
type_agents_Compiler
string
The compiler of the agent
type_agents_AgentTemplateEnum
string
The template of the agent
type_agents_TemplateOptions
The options for a templated agent.
type_commons_AgentLogId
string
Agent Log ID
type_agents_GetDetailedAgentLogResponse
object
1 property 1 required
type_commons_Pagination
object
pagination info
3 properties 3 required
type_commons_Error
object
2 properties 1 required
type_commons_ActorIdUnion
type_agents_AgentResponse
object
1 property
type_events_EventTopic
string
The topic of the event

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.