Get app output schema

Returns the JSON schema describing the output of a published NextRows app.

Currently, the API playground is under heavy development.
  • If you want to specify the extraction schema, please use the 'Open JSON Editor' button.
GET
/v1/apps/output-schema
AuthorizationBearer <token>

The API key to authenticate the request.

In: header

Query Parameters

appId*string

The ID of the app to fetch the output schema for.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.nextrows.com/v1/apps/output-schema?appId=abc123xyz"
{
  "success": true,
  "data": {
    "appId": "abc123xyz",
    "outputSchema": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Name": {
            "type": "string"
          },
          "Price": {
            "type": "number"
          }
        },
        "required": [
          "Name",
          "Price"
        ]
      }
    }
  }
}
{
  "success": false,
  "error": "Bad request"
}
{
  "success": false,
  "error": "Unauthorized"
}
{
  "success": false,
  "error": "Credits exhausted"
}
{
  "success": false,
  "error": "App not found"
}
{
  "success": false,
  "error": "Internal server error"
}