OpenAPI

The ProteinIQ OpenAPI specification describes public HTTP routes, authentication, request schemas, and response models. Use it for endpoint discovery, type generation, and integration checks.

Download the specification

The specification is public and does not require an API key:

curl --fail-with-body --silent --show-error \
  "https://proteiniq.io/openapi.json" \
  --output proteiniq-openapi.json

/api/v1/openapi.json serves the same document. Data routes still require bearer authentication.

Shared schemas and tool contracts

OpenAPI describes the shared envelopes for jobs, files, projects, workflows, and other resources. Each scientific tool has additional inputs, settings, and limits.

Read tool detail before preparing a request, then quote it to validate the chosen data and settings. Type checking a shared request shape cannot validate a protein sequence or every tool-specific constraint.

Generate TypeScript types

For example, use openapi-typescript to generate declarations:

npx openapi-typescript proteiniq-openapi.json -o proteiniq-api.d.ts

Import a response type from the generated paths:

import type { paths } from "./proteiniq-api";

type Account =
  paths["/api/v1/account"]["get"]["responses"][200]["content"]["application/json"];

This generates types, not an HTTP client or runtime validator. Your request code still needs to send authentication, check HTTP errors, and handle pagination and rate limits.

Keep an integration current

Save the specification version used by your client and regenerate types when adopting new routes or fields. Refresh tool contracts when updating an integration and verify representative requests with quotes before launching work.