> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Socrata Open Data: Socrata Describe Dataset

> Read a dataset's schema, column types, and freshness metadata. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Read a dataset's schema, column types, and freshness metadata.

> [!NOTE]
>
> Tool ID: `socrata_describe_dataset`

## Run this action

This action has conditional or dynamic inputs. A static example cannot describe these inputs reliably.

Read the live contract before you execute this action:

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline describe socrata_describe_dataset --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "id": "id_123",
    "name": "Example",
    "description": "Example description"
  }
}
```

Use `deepline describe socrata_describe_dataset --json` for the latest machine-readable contract.

## Input reference

Read a dataset's schema, column types, and freshness metadata

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.datasetId` | `string` | Yes | — | The dataset 4x4 identifier, e.g. `ipu4-2q9a`. Pattern: `^[a-z0-9]{4}-[a-z0-9]{4}$`. |
| `payload.domain` | `string` | Yes | — | Socrata host for this dataset, e.g. `data.cityofnewyork.us`. Routed at runtime. Not sent upstream as a query parameter. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Read a dataset's schema, column types, and freshness metadata",
    "properties": {
      "datasetId": {
        "type": "string",
        "description": "The dataset 4x4 identifier, e.g. `ipu4-2q9a`.",
        "pattern": "^[a-z0-9]{4}-[a-z0-9]{4}$"
      },
      "domain": {
        "type": "string",
        "description": "Socrata host for this dataset, e.g. `data.cityofnewyork.us`. Routed at runtime; not sent upstream as a query parameter."
      }
    },
    "required": [
      "datasetId",
      "domain"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.id` | `string` | No | — | — |
| `result.data.name` | `string` | No | — | — |
| `result.data.description` | `string` | No | — | — |
| `result.data.rowsUpdatedAt` | `integer` | No | — | — |
| `result.data.columns` | `array` | No | — | — |
| `result.data.columns[].fieldName` | `string` | No | — | — |
| `result.data.columns[].name` | `string` | No | — | — |
| `result.data.columns[].dataTypeName` | `string` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "rowsUpdatedAt": {
            "type": "integer"
          },
          "columns": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "fieldName": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "dataTypeName": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Socrata Open Data provider guide](https://deepline.com/docs/providers/socrata/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.