Blackboard Logo Dev Docs
search rss_feed menu

Upload a file to Ally

Start the process by uploading the file you would like to get feedback for. This is a multipart POST request. The response will contain the statusUrl that you can poll to check whether the file has been processed. If the file was processed previously, a resourceUrl will be provided through which you can fetch the feedback information immediately.

Supported content types


Endpoint

POST /api/v2/clients/:clientId/content

Path Parameters

Body Parameters

Query Parameters

Expected response

There are two potential outcomes:

  1. The file is new and will be processed asynchronously. The endpoint will return with a 202 Accepted response and the following response body:

    {
        "hash": "UkVBRE1FLm1k...",
        "status": "pending",
        "statusUrl": "/api/v2/clients/:clientId/content/UkVBRE1FLm1k.../status,
        "resourceUrl": null
    }
    
    Parameter Definition
    hash the content hash used to reference the file by Ally as a Service
    status the stage of processing the file is in*
    statusUrl the endpoint to call to check the status
    resourceUrl the endpoint to retrieve the report or metadata

    *The following status values can be identified:

    • success
    • pending
    • inprogress
    • failed
  2. The file has been processed before. The endpoint will return a 303 See Other with a Location header to the feedback URL

Testing with cURL

curl \
  -H "Authorization: Bearer myJwtToken" \
  -F"file=@test.pdf" https://prod.ally.ac/api/v2/clients/:clientId/content

Frequently Asked Questions

This section contains answers to many of the common questions we field as developers are on-boarding to the Ally as a Service API.

Upload - input

Upload - mechanics

Upload - output