API Documentation

Welcome to the Codata Public API documentation. This API allows you to programmatically access our privacy-enhancing technologies.
All endpoints require an X-API-Key header for authentication.

POST/api/v1/process

- Process Data With Api Key

Process data using API key authentication with PETs (Privacy Enhancing Technologies). Checks subscription status and decrements call count. Saves query execution to history if row count > 30.

Parameters
NameDescription
X-API-Key
*
string (header)		API Key for authentication
Request Body
application/json
{
  "data": {
    "additionalProp1": {}
  },
  "column_options": [],
  "column_analysis": {}
}

Fields:

  • data: Your data to process (dict with columns and rows)
  • column_options: List of column-specific PETs processing options
  • column_analysis: (Optional) Chart preferences. Format: {"column_name": "chart_type"}
Response 200

Successful Response

{
  "success": true,
  "message": "string",
  "processed_data": {
    "additionalProp1": {}
  },
  "subscription_info": {
    "additionalProp1": {}
  }
}
Response 422

Validation Error

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
GET/api/v1/subscription-info

- Get Subscription Info

Get subscription information for the current API key including plan details, remaining calls, and expiration date.

Parameters
NameDescription
X-API-Key
*
string (header)		API Key for authentication
Response 200

Successful Response

string
Response 422

Validation Error

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}