From portfolio data
to a reviewed result.

Start with a defined workflow.

Choose the portfolio problem, the input data, and the criteria you will use to accept a result. Record constraints such as allocation bounds, turnover, tax budgets, and account restrictions where supported by the selected task.

The API reference is the source for request fields, task types, and response formats. Request API access before sending authenticated requests.

Check the service.

The public health endpoint does not require an API key. The base path is hosted on the same domain as this site.

curl https://asymmetrycomputing.com/api/prism/v1/health

Keep your key on the server.

Authenticated endpoints use the X-API-Key header. Store the key in your server environment or secret manager. Avoid putting it in browser code, notebooks you publish, or source control.

X-API-Key: YOUR_API_KEY

See authentication for the exceptions and access process.

Check the available capabilities.

Use GET /v1/capabilities to inspect the supported task types and current limits. Evaluate account count, asset count, numerical quality, and runtime together on a representative workload.

Use the published benchmark evidence for its stated workload and measurement conditions. Establish acceptance criteria for your own data during the pilot.

Submit, poll, retrieve.

1. Prepare the data. Use a supported demonstration dataset or upload your own through the dataset endpoint.
2. Submit the job. Send the task and its parameters to POST /v1/jobs. Retain the returned job identifier.
3. Check its status. Poll GET /v1/jobs/{id} and handle pending, completed, and failed states.
4. Retrieve the result. Once completed, fetch /v1/jobs/{id}/result and the corresponding /weights output when available.

Open the request examples

Validate the result in context.

Check returned weights against the submitted constraints and your acceptance criteria. Review timings and the available audit record alongside portfolio-level outcomes before any downstream implementation.

For tax-aware workflows, include the relevant holdings and lot data and review proposed changes within your investment and tax controls.

Make failure states explicit.

Handle authentication errors, input validation failures, service limits, and job failures separately. Retain the job identifier for support, set a polling timeout appropriate to the workflow, and review a job’s status before resubmitting.

Read the limits and errors reference