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

Amigo Intake API

The Intake API from Amigo — 20 operation(s) for intake.

Amigo Intake API is one of 72 APIs that Amigo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Intake. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 23 operations across 20 paths, and defines 42 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against 5 base URLs: https://api.amigo.ai, https://internal-api.amigo.ai, https://api-eu-central-1.amigo.ai, https://api-ap-southeast-2.amigo.ai, https://api-ca-central-1.amigo.ai.

23 operations 20 paths 42 schemas 1 DELETE12 GET10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.amigo.ai
Authentication
HTTP Bearer, API Key, HTTP Basic
Resource Areas
1

Authentication & Security 3

Amigo Intake API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer-Authorization). An API key is passed in the header as X-ORG-ID (Bearer-Authorization-Organization). It accepts HTTP basic authentication (Basic). By default, every request must be authenticated.

  • Bearer-Authorization — Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the [SignInWithAPIKey](sign-in-wi…
  • Bearer-Authorization-Organization — An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is ma…
  • Basic — The username should be set to {orgid}{userid}, and the password should be the Amigo issued JWT token that identifies the user.

Paths & Operations 23

Across 20 paths, the API surfaces 23 operations — 1 DELETE, 12 GET, 10 POST. Each is listed below with its method, path, parameters, and response codes.

Intake 23
POST
/v1/{workspace_id}/intake/files/external
Receive Intake File
receive_intake_file_v1__workspace_id__intake_files_external_post 7 params → 201422
GET
/v1/{workspace_id}/intake/files
List Intake Files
list_intake_files_v1__workspace_id__intake_files_get 7 params → 200422
POST
/v1/{workspace_id}/intake/files
Upload Intake File
upload_intake_file_v1__workspace_id__intake_files_post 1 param body → 201422
GET
/v1/{workspace_id}/intake/files/{file_id}/download
Download Intake File
download_intake_file_v1__workspace_id__intake_files__file_id__download_get 2 params → 200422
GET
/v1/{workspace_id}/intake/datasets
List Intake Datasets
list_intake_datasets_v1__workspace_id__intake_datasets_get 5 params → 200422
POST
/v1/{workspace_id}/intake/sources
Register Intake Source
register_intake_source_v1__workspace_id__intake_sources_post 1 param body → 201422
GET
/v1/{workspace_id}/intake/sources
List Intake Sources
list_intake_sources_v1__workspace_id__intake_sources_get 4 params → 200422
POST
/v1/{workspace_id}/intake/sources/{source_id}/sync
Sync Intake Source
sync_intake_source_v1__workspace_id__intake_sources__source_id__sync_post 2 params → 201422
POST
/v1/{workspace_id}/intake/schema/register
Register Intake Schema
register_intake_schema_v1__workspace_id__intake_schema_register_post 1 param body → 201422
GET
/v1/{workspace_id}/intake/batches
List Intake Batches
list_intake_batches_v1__workspace_id__intake_batches_get 5 params → 200422
GET
/v1/{workspace_id}/intake/batches/{batch_id}
Get Intake Batch
get_intake_batch_v1__workspace_id__intake_batches__batch_id__get 2 params → 200422
GET
/v1/{workspace_id}/intake/batches/{batch_id}/processing-manifest
Get Batch Processing Manifest
get_batch_processing_manifest_v1__workspace_id__intake_batches__batch_id__processing_manifest_get 2 params → 200422
POST
/v1/{workspace_id}/intake/batches/{batch_id}/process
Process Intake Batch
process_intake_batch_v1__workspace_id__intake_batches__batch_id__process_post 2 params → 202422
POST
/v1/{workspace_id}/intake/materialize
Materialize Intake
materialize_intake_v1__workspace_id__intake_materialize_post 1 param body → 202422
POST
/v1/{workspace_id}/intake/datasets/{dataset}/update
Update Intake Dataset
update_intake_dataset_v1__workspace_id__intake_datasets__dataset__update_post 2 params → 202422
GET
/v1/{workspace_id}/intake/update-runs/{run_id}
Get Intake Update Run
get_intake_update_run_v1__workspace_id__intake_update_runs__run_id__get 2 params → 200422
GET
/v1/{workspace_id}/intake/materializations
List Intake Materializations
list_intake_materializations_v1__workspace_id__intake_materializations_get 5 params → 200422
POST
/v1/{workspace_id}/intake/files/{file_id}/status
Write Back Intake File Status
write_back_intake_file_status_v1__workspace_id__intake_files__file_id__status_post 2 params body → 200422
POST
/v1/{workspace_id}/intake/links
Generate upload link
create-intake-link 1 param body → 201422
GET
/v1/{workspace_id}/intake/links
List upload links
list-intake-links 4 params → 200422
DELETE
/v1/{workspace_id}/intake/links/{link_id}
Revoke upload link
revoke-intake-link 2 params → 204422
GET
/v1/{workspace_id}/intake/links/{link_id}/uploads
List uploads for a link
list-intake-link-uploads 4 params → 200422
GET
/v1/{workspace_id}/intake/links/{link_id}/uploads/{upload_id}/download
Download an uploaded file
download-intake-upload 3 params → 200404502422

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are IntakeFileRow (13 properties), IntakeLinkResponse (13 properties), FileEntry (11 properties), DatasetUpdateRunResponse (10 properties). Each schema is shown below with its type and property counts.

PaginatedResponse_IntakeFileRow_
object
4 properties 2 required
BatchProcessingManifest
object
Per-file extraction params for a document batch's still-received files — consumed by the batch-extract job, which runs ONCE per batch and extracts every file (…
2 properties 2 required
PaginatedResponse_IntakeSourceRow_
object
4 properties 2 required
StatusWriteBackRequest
object
Status advance written by the async CDC job (P4). The job posts the terminal verdict after conform/validate/diff. errorreason must be PHI-safe (the engine repo…
4 properties 1 required
IntakeFileResponse
object
5 properties 5 required
DescriptionString
string
Limits
object
1 property
PaginatedResponse_BatchRow_
object
4 properties 2 required
IntakeSourceRow
object
A registered intake source (Sources list).
9 properties 7 required
DriveFolderMapping
object
One Google Drive folder ↔ one intake dataset. folderid is the Drive folder id (the identity — never the folder name, which can be renamed/moved). One folder ma…
2 properties 2 required
RegisterSourceRequest
object
Register a Google Shared Drive intake source (design §3). The credential is not part of the wire contract — the server derives the SA-key SSM path deterministi…
4 properties 2 required
IntakeUploadResponse
object
8 properties 8 required
SlugString
string
SyncBatchRow
object
One batch produced by a source sync (one per mapped folder/dataset).
4 properties 4 required
FileEntry
object
11 properties 8 required
NameString
string
PaginatedResponse_DatasetRow_
object
4 properties 2 required
MaterializeRequest
object
1 property
BatchRow
object
A source-sync batch (Batches list / detail).
6 properties 5 required
DatasetUpdateRunResponse
object
Durable status for one dataset update action.
10 properties 7 required
_FileType
string
_FileStatus
string
BatchDetail
object
7 properties 5 required
HTTPValidationError
object
1 property
DocumentProcessingSpec
object
Processing config for a document dataset (ingestionmode=document). Documents have no schema/primary-key/CDC; this is what the contract carries instead (docs/pl…
2 properties
DatasetRow
object
A registered schema in the Schemas list (intake-ui-mvp-design.md §5.3).
7 properties 6 required
_DatasetUpdateStatus
string
IntakeLinkResponse
object
13 properties 13 required
ValidationError
object
5 properties 3 required
SourceSyncResponse
object
1 property 1 required
IntakeFileRow
object
A file in the Files list (intake-ui-mvp-design.md §5.1).
13 properties 6 required
_FieldName
string
Body_upload_intake_file_v1__workspace_id__intake_files_post
object
3 properties 2 required
MaterializeResponse
object
1 property
PaginatedResponse_MaterializationRow_
object
4 properties 2 required
RegisterSchemaRequest
object
Create Schema payload (intake-ui-mvp-design.md §5.4, §5.9). ingestionmode is inferred from filetype (csv/xls/xlsx → snapshot; else document) — not part of the…
7 properties 2 required
_VolumePath
string
SchemaFieldSpec
object
2 properties 2 required
IntakeFieldType
string
Allowed schema[].type values for a registered contract. Confirmed set (intake-ui-mvp design contract point 1): scalars plus ISO date/datetime. Coercion semanti…
CreateLinkRequest
object
4 properties 1 required
_DatasetSlug
string
MaterializationRow
object
Per-dataset status of the customer-data destination table (customerdata . . ).
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-intake-api-openapi.yml Raw ↑

Other APIs Amigo publishes across the network.

Amigo Account API
Amigo Admin API
Amigo Agent Definitions API
Amigo Agent Runs API
Amigo Agents API
Amigo Analytics API
Amigo API Keys API
Amigo Audit API
Amigo Auth API
Amigo Billing API
Amigo Calls API
Amigo Command Center API
Where this information came from

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