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_documents API

The subpackage_documents API from Flatfile — 2 operation(s) for subpackage_documents.

Flatfile subpackage_documents 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 5 operations across 2 paths, and defines 28 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.

5 operations 2 paths 28 schemas 1 DELETE2 GET1 PATCH1 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_documents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (default).

Paths & Operations 5

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

subpackage_documents 5
GET
/spaces/{spaceId}/documents
List documents
list 3 params → 200400404
POST
/spaces/{spaceId}/documents
Create a document
create 3 params body → 200400404
GET
/spaces/{spaceId}/documents/{documentId}
Get a document
get 4 params → 200400404
PATCH
/spaces/{spaceId}/documents/{documentId}
Update a document
update 4 params body → 200400404
DELETE
/spaces/{spaceId}/documents/{documentId}
Delete a document
delete 4 params → 200400404

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are type_commons:Action (25 properties), type_documents:Document (11 properties), type_commons:InputField (7 properties), type_commons:InputEnumPropertyOption (6 properties). Each schema is shown below with its type and property counts.

type_commons:Success
object
Informs whether or not a request was successful
1 property
type_documents:DocumentConfig
object
4 properties 2 required
type_commons:Guide
object
1 property 1 required
type_commons:InputConstraintType
string
type_commons:ActionMode
string
Foreground actions will prevent interacting with the resource until complete
type_commons:ActionSchedule
string
type_commons:ActionMessageType
string
type_commons:ActionId
string
Action ID
type_documents:DocumentResponse
object
1 property 1 required
type_commons:InputConstraint
object
1 property 1 required
type_commons:ActionMessage
object
2 properties 2 required
type_commons:EnvironmentId
string
Environment ID
type_commons:InputForm
object
2 properties 2 required
type_commons:Error
object
2 properties 1 required
type_commons:InputField
object
7 properties 3 required
type_commons:SuccessData
object
1 property 1 required
type_commons:ActionConstraint
type_commons:ActionMount
type_commons:InputFormType
string
type_commons:InputConfig
object
1 property 1 required
type_documents:ListDocumentsResponse
object
1 property 1 required
type_commons:InputEnumPropertyOption
object
6 properties 1 required
type_commons:Errors
object
1 property 1 required
type_commons:Action
object
25 properties 1 required
type_commons:SpaceId
string
Space ID
type_commons:Guardrail
object
1 property 1 required
type_documents:Document
object
A document (markdown components) belong to a space
11 properties 5 required
type_commons:DocumentId
string
Document ID

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

flatfile-subpackage-documents-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_agents 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_entitlements API
Where this information came from

This is an independent, third-party profile of Flatfile subpackage_documents 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.