Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Nace Ai

Nace Ai public-api API

The public-api API from Nace Ai — 12 operation(s) for public-api.

Documentation Provider Profile APIs.io OpenAPI GitHub

Nace Ai public-api API is one of 2 APIs that Nace Ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include public-api. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a quickstart.

This API exposes 12 operations across 12 paths, and defines 38 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against the base URL https://ndi-api.nace.ai/api/v1.

12 operations 12 paths 38 schemas 2 GET10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://ndi-api.nace.ai/api/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Nace Ai public-api API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (APIKeyHeader).

Paths & Operations 12

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

public-api 12
POST
/api/v1/parse_async
Parse Async
parse_async_api_v1_parse_async_post body → 202400401402403404409413
POST
/api/v1/parse
Parse Sync
parse_sync_api_v1_parse_post 1 param body → 200400401402403404409413
POST
/api/v1/upload
Upload File
upload_file_api_v1_upload_post body → 200400401402403404409413
POST
/api/v1/ground_async
Ground Async
ground_async_api_v1_ground_async_post body → 202400401402403404409413
POST
/api/v1/ground
Ground Sync
ground_sync_api_v1_ground_post 1 param body → 200400401402403404409413
POST
/api/v1/categorize_async
Categorize Async
categorize_async_api_v1_categorize_async_post body → 202400401402403404409413
POST
/api/v1/categorize
Categorize Sync
categorize_sync_api_v1_categorize_post 1 param body → 200400401402403404409413
POST
/api/v1/extract_async
Extract Async
extract_async_api_v1_extract_async_post body → 202400401402403404409413
POST
/api/v1/extract
Extract Sync
extract_sync_api_v1_extract_post 1 param body → 200400401402403404409413
GET
/api/v1/jobs
List Jobs
list_jobs_api_v1_jobs_get 3 params → 200400401402403404409413
GET
/api/v1/jobs/{job_id}
Get Job
get_job_api_v1_jobs__job_id__get 1 param → 200400401402403404409413
POST
/api/v1/jobs/{job_id}/cancel
Cancel Job
cancel_job_api_v1_jobs__job_id__cancel_post 1 param → 200400401402403404409413

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are VisualRegionMatch (9 properties), CategorizedSegment (8 properties), JobStatus (8 properties), ExtractResult (7 properties). Each schema is shown below with its type and property counts.

JsonValue
CategorizeResult
object
4 properties
UploadResponse
object
Returned by POST /upload: an opaque handle for later job starts.
3 properties 3 required
CategorizedSegment
object
8 properties 5 required
JobError
object
2 properties 2 required
ErrorDetail
object
Inner error envelope used by :class:ErrorResponse. requestid is always populated; callers can quote it back to support so we can correlate against logs without…
3 properties 3 required
VisualRegionMatch
object
9 properties 5 required
JobStatus
object
Response for GET /jobs/{jobid} and the sync endpoints.
8 properties 4 required
GroundVisualHints
object
2 properties
JobList
object
Response for GET /jobs: newest first, cursor-paginated.
2 properties
ParsedFile
object
5 properties 1 required
JobSummary
object
One row of GET /jobs — deliberately light (no result payloads).
6 properties 4 required
AudioRangeMatch
object
5 properties 2 required
ParsedSheet
object
6 properties 2 required
GroundJobRequest
object
Body for POST /ground and POST /groundasync.
5 properties 2 required
GroundItemHints
object
2 properties
ExtractJobRequest
object
Body for POST /extract and POST /extractasync.
4 properties 2 required
GroundSpreadsheetHints
object
3 properties
ExtractResult
object
7 properties
Body_upload_file_api_v1_upload_post
object
1 property 1 required
JobAccepted
object
Returned by the async endpoints: the job started, poll GET /jobs/{jobid}.
1 property 1 required
ParseJobRequest
object
Body for POST /parse and POST /parseasync.
2 properties 1 required
CategorizeJobRequest
object
Body for POST /categorize and POST /categorizeasync.
4 properties 1 required
GroundItem
object
One value to locate in the source document.
4 properties 2 required
GroundItemResult
object
4 properties 1 required
TextRangeMatch
object
5 properties 2 required
ErrorResponse
object
Top-level error body returned by every non-2xx response. The OpenAPI schema declares this shape so client SDKs can branch on response.error.code deterministica…
1 property 1 required
GroundOptions
object
Caller-tunable grounding options. Providers and model settings are server-owned.
2 properties
ParseResult
object
4 properties
JsonlRecordMatch
object
5 properties 2 required
GroundResult
object
5 properties
FileInput
object
The document to process.
2 properties 1 required
ParsedTable
object
2 properties
SpreadsheetRangeMatch
object
5 properties 1 required
TaxonomyCategory
object
2 properties 1 required
CategorizedSheet
object
7 properties 4 required
Taxonomy
object
1 property 1 required
GroundDerivedSources
object
Artifacts from prior NDI runs that speed up / improve grounding.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nace-ai-public-api-api-openapi.yml Raw ↑

Other APIs Nace Ai publishes across the network.

Nace Ai health API
AE Profile APIs.io
#public-api
← Back to N APIs
API Details
ID
nace-ai:nace-ai-public-api-api
Base URL
https://ndi-api.nace.ai/api/v1
Docs
https://docs.ndi.nace.ai
Provider
Nace Ai
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network