Attach custom fields to your Speak AI media records

Retrieve Fields

This endpoint makes an HTTP GET request to retrieve a list of fields.

Request

The request does not require a request body. It simply makes a GET request to the endpoint https://api.speakai.co/v1/fields.

Response

The response will be a JSON object representing the list of fields. Below is a JSON schema representing the structure of the response:

{
  "type": "object",
  "properties": {
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "fieldId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        }
      }
    }
  }
}

The fields array contains objects with fieldId, name, type, and description properties, representing the details of each field.

Add Field

This endpoint allows you to add a new field.

Request Body

• description (string, required): A description of the field.

• name (string, required): The name of the field.

• type (string, required): The type of the field.

• privacyMode (string, required): The privacy mode of the field. “public” or “private”.

Response

The response will contain the details of the newly added field.

Request body

Field types and names come from the request body the spec records. The spec does not mark request body fields as required, so read this as the shape the endpoint accepts rather than a required field list.

Update Field Information

This endpoint allows you to update the information of a specific field.

Request Body

• description (string, required): The updated description of the field.

• name (string, required): The new name of the field.

Example:

{
    "description": "Currency Description Updated",
    "name": "New Updated Name",
    "privacyMode": "public"
}

Response

• status (string): The status of the response.

• data (object): An object containing the updated field information.

  • id (string): The ID of the field.

  • name (string): The name of the field.

  • description (string): The description of the field.

  • type (string): The type of the field.

  • isActive (boolean): Indicates if the field is active.

  • privacyMode (string): The privacy mode of the field.

  • createdAt (string): The date and time of creation.

  • updatedAt (string): The date and time of the last update.

Example Response:

{
    "status": "",
    "data": {
        "id": "",
        "name": "",
        "description": "",
        "type": "",
        "isActive": true,
        "privacyMode": "",
        "createdAt": "",
        "updatedAt": ""
    }
}

Parameters

Request body

Field types and names come from the request body the spec records. The spec does not mark request body fields as required, so read this as the shape the endpoint accepts rather than a required field list.

Set custom field values across media. Scope with folderId (all media in a folder) and/or mediaIds (specific files). Each fields entry is { id, value }.

Request body

Field types and names come from the request body the spec records. The spec does not mark request body fields as required, so read this as the shape the endpoint accepts rather than a required field list.