For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Community
Create Account
Sign in
Community
Create Account
Sign in
API Reference
Agents
Get an agent
Copy page
GET
https://api.x.flatfile.com/v1
/
agents
/
:agentId
Authentication
Authorization
Bearer
Bearer authentication of the form
Bearer <token>
, where token is your auth token.
Path parameters
agentId
string
Required
Agent ID
Headers
X-Disable-Hooks
"true"
Required
Query parameters
environmentId
string
Optional
Environment ID
Response
This endpoint returns an object.
data
object
Show 19 properties
Errors
400
Bad Request Error
404
Not Found Error