Skip to main content
    Ivy Biosciences Docs/Call the platform/API/REST API/Artifacts & Storage

    Artifacts & Storage

    List a finished job's output files and fetch each 5-minute download_url — PDB, SDF, CSV, TXT, ZIP or JSON; the route returns 409 until the job completes.

    restartifactsstoragedownload

    Artifacts & Storage is how you retrieve the files a job produces — PDB structures, SDF molecules, CSV reports — once it completes. Reach for it after a job you submitted through the Jobs API finishes and you need its outputs. It's the retrieval half of the job lifecycle that the Jobs API starts.

    Difficulty

    beginner

    Time

    8 min

    Artifacts & Storage

    A finished job's outputs (PDB structures, SDF molecules, CSV reports) are stored with the job. GET /api/v1/jobs/:jobId (reference) returns the finished record, including its output artifact references.

    Try it live: Open the Interactive API Reference to test these endpoints directly from your browser.


    Downloading Outputs

    GET /api/v1/jobs/:jobId/artifacts (reference) lists a finished job's output files. Each entry has a download_url that works for 5 minutes. Fetch it with a plain GET and no auth header:

    curl "https://www.ivybiosciences.com/api/v1/jobs/$JOB_ID/artifacts?types=pdb,csv" \
      -H "Authorization: Bearer ivy_your_key"
    
    # then, for each artifact
    curl -o structure.pdb "$DOWNLOAD_URL"

    The route needs an API key or a signed-in session that can read the job. It returns 409 until the job has completed. A job you can't read returns 404, the same as a job that doesn't exist. When the links expire, call the route again for new ones.

    The CLI does the same in one step:

    ivybloom jobs download job_abc123

    Files your chat's code sandbox exports have their own download operation: GET /api/harness/sandbox/:chatId/export/:assetId/download (reference) returns a short-lived signed link.


    Artifact Types

    The download route lists these types; pass any subset as types:

    TypeExtensionDescription
    pdb.pdbProtein Data Bank structure file
    sdf.sdfStructure-Data File (molecules)
    csv.csvTabular results
    txt.txt, .logText output and logs
    zip.zipBundled outputs
    json.jsonStructured data

    Without a key

    The operations on this page need an API key or a session. A caller with no key starts with the keyless orchestrate request in Guest curl; guest behaviour and limits are stated once, in llms.txt.

    Was this page helpful?

    On this page

    On this page

    Loading...