embeddings

Compute protein-language-model embeddings for protein sequences.

Provide sequence (single), sequences (a list), or input (one fasta/yaml blob). No structure, no MSA, only the LM trunk. Returns a job to poll.

post/v1/embeddings

Request

  • Base URL: https://api.japanfold.aiand.com
  • URL: https://api.japanfold.aiand.com/v1/embeddings
  • Auth: one of:
    • none
    • HTTP bearer

Headers

Idempotency-Keystring

Resend a submit with the same key and body to get the first job back instead of a second one to pay for. The same key with a different body is a 422. Keys are remembered on the account for good, so make each new submission's key unique (a UUID), not a readable name you might reuse.

Request body

inputstring

One FASTA/YAML string (flat {id: sequence}).

model'esmc-300m' | 'esmc-600m' | 'esmc-6b' | 'saprot-650m' | 'saprot-1.3b'
namestring
paramsobject

pool (mean|max|cls), format (npz|parquet), fast. Omitted params take the default GET /v1/models advertises (mean pooling, npz, fast off).

sequencestring

Single protein sequence (convenience).

Response

Job

artifactsobject[]

Present on a succeeded job read by its id (not in the list), when it has at most 20 files: the same entries as artifacts in its results. A job with more files lists them only in its results.

attemptinteger

Present only when the job's structure is on its second run, because the box running it stopped answering (hung, or its agent died); its progress started over. A job of several structures carries it on the retried entry of targets. Billed once.

created_atstring date-time nullable
doneinteger
downloadstring

Present on a succeeded job read by its id: one shell command that fetches every result file into the current directory, reading the key from JAPANFOLD_API_KEY. Past 20 files it fetches and unzips the archive instead.

email_when_doneboolean

Present once POST /v1/jobs/{id}/notify has been asked.

errorstring nullable

Why the job failed; on a succeeded job, what it could not deliver (see partial).

finished_atstring date-time nullable
idstring required
kind'predict' | 'design' | 'embed' required
linksobject
modelstring nullable
namestring
object'job' required
progressnumber nullable

0..1, or null when indeterminate

protocolstring nullable
results_readyboolean
stagestring nullable
started_atstring date-time nullable
status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' required
totalinteger
waiting_for_deviceboolean

Present and true only while the job has been accepted but no processor is free for it yet. The job is queued, not stalled.

Changes

No recorded changes to this operation across all 1 revision of this API.