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

The subpackage_environments API from Flatfile — 6 operation(s) for subpackage_environments.

Flatfile subpackage_environments 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 12 operations across 6 paths, and defines 25 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.

12 operations 6 paths 25 schemas 2 DELETE6 GET2 PATCH2 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_environments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (default).

Paths & Operations 12

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

subpackage_environments 12
GET
/environments
List environments
list 4 params → 200
POST
/environments
Create an environment
create 2 params body → 200
GET
/environments/subscription-token
Get environment subscription credentials
get-environment-event-token 3 params → 200400404
GET
/environments/{environmentId}
Get an environment
get 3 params → 200400404
PATCH
/environments/{environmentId}
Update an environment
update 3 params body → 200
DELETE
/environments/{environmentId}
Delete an environment
delete 3 params → 200400404
GET
/environments/{environmentId}/guides
List guides
list-guides 3 params → 200400404
POST
/environments/{environmentId}/guides
Create a guide
create-guide 3 params body → 200400404
GET
/environments/{environmentId}/guides/{guideId}
Get a guide
get-guide 4 params → 200400404
PATCH
/environments/{environmentId}/guides/{guideId}
Update a guide
update-guide 4 params body → 200400404
DELETE
/environments/{environmentId}/guides/{guideId}
Delete a guide
delete-guide 4 params → 200400404
GET
/environments/{environmentId}/guides/{guideId}/versions/{version}
Get guide version
get-guide-version 5 params → 200400404

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are type_environments:Environment (10 properties), type_environments:GuideResource (9 properties), type_environments:GuideUpdateRequest (7 properties), type_environments:EnvironmentConfigUpdate (7 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_environments:GuideVersionResponse
object
1 property 1 required
type_environments:EnvironmentResponse
object
1 property 1 required
type_spaces:EventToken
object
Properties used to allow users to connect to the event bus
4 properties
type_environments:GuideCreateRequest
object
Create a guide
6 properties 5 required
type_environments:EnvironmentConfigUpdate
object
Properties used to update an environment
7 properties
type_spaces:EventTokenResponse
object
1 property 1 required
type_environments:GuideResource
object
A guide
9 properties 7 required
type_environments:GuideDeleteResponseData
object
1 property 1 required
type_commons:EnvironmentId
string
Environment ID
type_commons:Error
object
2 properties 1 required
type_environments:GuestAuthenticationEnum
string
The type of authentication to use for guests
type_environments:GuideListResponse
object
1 property 1 required
type_commons:SuccessData
object
1 property 1 required
type_commons:Pagination
object
pagination info
3 properties 3 required
type_commons:GuideId
string
Guide ID
type_commons:Errors
object
1 property 1 required
type_environments:GuideVersionResource
object
A version of a guide
5 properties 5 required
type_environments:Environment
object
10 properties 7 required
type_environments:ListEnvironmentsResponse
object
2 properties 1 required
type_environments:GuideDeleteResponse
object
1 property 1 required
type_environments:GuideUpdateRequest
object
Update a guide
7 properties
type_environments:EnvironmentConfigCreate
object
Properties used to create a new environment
7 properties 2 required
type_commons:AccountId
string
Account ID
type_environments:GuideDetailResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

flatfile-subpackage-environments-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_documents API
Where this information came from

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