Retrieve Dataset Metadata | Dadosfera AutoDriveDDF API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Description

Retrieve full metadata for one dataset.

Use this endpoint to read-only check:

  • Whether a newly-uploaded dataset has finished processing (status = "success").
  • Immutable properties such as created_at, updated_at, and customer_name.
  • The dataset’s current ingestion state (status_reason if the state ≠ success).

HTTP Request

GET /dataset/{dataset_id}

 

LocationNameTypeRequiredDescription
Pathdataset_idstringUUID returned at upload time, e.g. c8004e22-87f7-441f-8302-80c934841196.


Authentication

In your REST client (Postman/Insomnia), select Basic Auth and enter your Username and Password.

The client will automatically generate the Authorization: Basic … header for you. Do not add that header manually.



Required Headers

HeaderExampleNotes
Acceptapplication/jsonOptional – guarantees JSON output.

Example Request (cURL)

curl -u admin:myPassword \
     https://api.autodriveddf.example/dataset/c8004e22-87f7-441f-8302-80c934841196

Success Response (200 OK)

{
  "dataset_id": "c8004e22-87f7-441f-8302-80c934841196",
  "name": "platform_knowledge_base",
  "status": "success",
  "status_reason": null,
  "customer_name": "dadosferaDemo",
  "instance_id": "78b9e8c0-a123-4e56-9f01-abcdef123456",
  "created_at": "2025-05-04T14:46:58.802Z",
  "updated_at": "2025-06-10T09:30:12.500Z"
}
FieldTypeDescription
dataset_idstringCanonical UUID for this dataset.
namestringHuman-readable name assigned at upload.
statusstringOne of success, processing, or failed.
status_reasonstringNull on success; otherwise a brief reason for failure.
customer_namestringTenant / account identifier.
instance_idstringInternal processing instance (for audit/debug only).
created_atstringISO-8601 timestamp when the dataset was first uploaded.
updated_atstringISO-8601 timestamp of the most recent file addition or metadata update.

Error Responses

CodeReasonWhen it happensSample Body
401UnauthorizedMissing / wrong Basic Auth credentials
404Not Founddataset_id does not exist or is hidden{ "detail": "Dataset not found" }
500Internal ServerErrorUnexpected server failure{ "detail": "Unexpected error occurred" }

Idempotency

GET /dataset/{dataset_id} is idempotent and read-only — repeated calls return the same metadata unless the dataset itself changes (e.g., new documents uploaded via PUT /dataset/{dataset_id}).

Path Params
string
required
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json