Get Nid from File

This is an API to help you retrieve the Cid/Nid of any file. It requires either a fileURL or a file object along with a valid Capture Token for authorization. If you do not already have a Capture Token yet, please follow the instructions provided to create one.

API Endpoint:

Cost: 0.01 NUM

Method: POST

This is an API to help you retrieve the Nid of any file.

This API requires a valid token for Authorization. The token should be passed in the headers of the request using the following format: "Authorization: token YOUR_CAPTURE_TOKEN"

Authorization: token $YOUR_CAPTURE_TOKEN (required)
Content-Type: application/json

Request Body (required):
fileURL (string) or file (object): Either the URL of the file or the file object itself must be specified. If the fileURL is used, it should be passed as a string. If the file object is used, it should be the direct upload from the system.

Request Body (optional):
version (integer): CID version (default: 1)

Example 1 (direct file upload):
curl -F "file=@/tmp/MYFILE.png" \
     -H "Authorization: token YOUR_CAPTURE_TOKEN" \

Example 2 (upload via URL)
curl -X POST "" \
     -H "Content-Type: application/json" \
     -H "Authorization: token YOUR_CAPTURE_TOKEN" \
     -d '{
         "fileURL": FILE_URL

    "cid": string, // content identifier of the file
    "fileSize": integer, // size of the file
    "cid_version": integer // version of the cid

200: Cid/Nid retrieved successfully
400: Bad request
401: Unauthorized
403: Forbidden
500: Internal Server Error

In this example, you would replace YOUR_CAPTURE_TOKEN with your actual Capture token and /tmp/MYFILE.png with the actual file on your filesystem. More examples can be found below:

import requests

url = ""
headers = {
    "Content-Type": "application/json",
    "Authorization": "token YOUR_CAPTURE_TOKEN"
data = {
  "fileURL": FILE_URL,
  "version": 1

response =, headers=headers, json=data)

if response.status_code == 200:
    response_json = response.json()
    print("Request failed with status code:", response.status_code)

Last updated