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

One Codex Documents API

The Documents API from One Codex — 9 operation(s) for documents.

One Codex Documents API is one of 25 APIs that One Codex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 10 operations across 9 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://app.onecodex.com.

10 operations 9 paths 1 schemas 1 DELETE2 GET1 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://app.onecodex.com/api/v1/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

One Codex Documents API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (apiKeyAuth). By default, every request must be authenticated.

Paths & Operations 10

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

Documents 10
GET
/api/v1/documents
GET documents instances
get_documents_instances 4 params → 200
POST
/api/v1/documents/confirm_upload
POST documents instancesconfirmupload
post_documents_instances_confirm_upload body → 200
POST
/api/v1/documents/init_multipart_upload
Start a multipart upload directly to S3.
post_documents_instances_init_multipart_upload → 200
POST
/api/v1/documents/init_upload
Deprecated in favour of initmultipartupload
post_documents_instances_init_upload body → 200
DELETE
/api/v1/documents/{id}
DELETE documents
delete_documents_self 1 param → 204
GET
/api/v1/documents/{id}
GET documents
get_documents_self 1 param → 200
POST
/api/v1/documents/{id}/add_user
POST documents adduser
post_documents_add_user 1 param body → 200
POST
/api/v1/documents/{id}/download_uri
POST documents downloaduri
post_documents_download_uri 1 param → 200
POST
/api/v1/documents/{id}/remove_user
POST documents removeuser
post_documents_remove_user 1 param body → 200
PATCH
/api/v1/documents/{id}/rename
PATCH documents rename
patch_documents_rename 1 param body → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is documents (6 properties). Each schema is shown below with its type and property counts.

documents
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

one-codex-documents-api-openapi.yml Raw ↑

Other APIs One Codex publishes across the network.

One Codex Account API
One Codex Alignments API
One Codex Analyses API
One Codex Annotation Sets API
One Codex Assemblies API
One Codex Assets API
One Codex Classifications API
One Codex Controls API
One Codex Events API
One Codex Functional Profiles API
One Codex Genomes API
One Codex Jobs API
Where this information came from

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