# Publicatiecredits voor X ophalen

Canonieke URL: https://sosoapi.ai/nl/docs/mcp/get-x-usage

`sosoapi_get_x_usage`

Lees de X-publicatiecredits van de organisatie die deze werkruimte deelt. Vereist workspace_id. Free krijgt eenmalig 10; Pro krijgt 100 per factureringsperiode. Tekst kost 1, tekst met een URL kost 10. Optionele text toont de kosten ervan. Dit leest de opgeslagen toelage en roept geen X API aan.

## Profielen en transporten

Profielen: core, full

Transporten: stdio, http

Kies core of full om te bepalen welke tools je client ziet; dit verandert geen machtigingen. Lokale bestandsupload vereist stdio en is niet beschikbaar via HTTP. Stel SOSOAPI_OUTPUT_SCHEMAS=1 in om uitvoerschema's bij detectie op te nemen. Tools geven met en zonder die instelling gestructureerde resultaten terug.

## Machtigingen en neveneffecten

Annotaties helpen clients een tool te beschrijven. Elke aanroep controleert nog steeds gebruikersauthenticatie, rol, resourcetoegang en verleende bevoegdheden.

```json
{
  "readOnlyHint": true,
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false
}
```

`/studio-api/x/usage` — agent:operate; synchronous_http_response

## Invoervelden

```json
{
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    },
    "text": {
      "type": "string",
      "maxLength": 4096
    }
  },
  "required": [
    "workspace_id"
  ],
  "additionalProperties": false
}
```

## Gestructureerde uitvoer

Dit schema beschrijft structuredContent in een geslaagd toolresultaat. Het MCP-antwoord bevat ook content en kan isError instellen wanneer een aanroep mislukt. Lees bij publiceren het definitieve berichtresultaat; beschouw een geaccepteerd verzoek of tekstantwoord niet als bevestiging. De gekoppelde API-bewerking beschrijft machtigingen en regels voor opnieuw proberen.

```json
{
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    },
    "plan": {
      "type": "string",
      "enum": [
        "free",
        "founding_pro"
      ]
    },
    "allowance": {
      "type": "string",
      "enum": [
        "one_time",
        "monthly"
      ]
    },
    "period_start": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    },
    "period_end": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        },
        {
          "type": "null"
        }
      ]
    },
    "limit": {
      "anyOf": [
        {
          "type": "number",
          "const": 10
        },
        {
          "type": "number",
          "const": 100
        }
      ]
    },
    "reserved": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "consumed": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "remaining": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "costs": {
      "type": "object",
      "properties": {
        "text": {
          "type": "number",
          "const": 1
        },
        "with_url": {
          "type": "number",
          "const": 10
        }
      },
      "required": [
        "text",
        "with_url"
      ],
      "additionalProperties": false
    },
    "draft_credits": {
      "anyOf": [
        {
          "type": "number",
          "const": 1
        },
        {
          "type": "number",
          "const": 10
        }
      ]
    }
  },
  "required": [
    "workspace_id",
    "plan",
    "allowance",
    "period_start",
    "period_end",
    "limit",
    "reserved",
    "consumed",
    "remaining",
    "costs"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}
```

## Voorbeeld van een toolaanroep

Deze voorbeelden gebruiken fictieve waarden die tegen de schema's zijn gecontroleerd. Vervang IDs door toegestane IDs, media door gereedstaande bestanden en datums door je bevestigde publicatietijd. Controleer accountgeschiktheid vóór een schrijfhandeling. Deze pagina verstuurt geen API-verzoeken.

```json
{
  "name": "sosoapi_get_x_usage",
  "arguments": {
    "workspace_id": "11111111-1111-4111-8111-111111111111"
  }
}
```

structuredContent

```json
{
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "plan": "free",
  "allowance": "one_time",
  "period_start": "2099-01-15T09:00:00Z",
  "period_end": null,
  "limit": 10,
  "reserved": 0,
  "consumed": 0,
  "remaining": 0,
  "costs": {
    "text": 1,
    "with_url": 10
  }
}
```

## Onderliggende API-bewerkingen

- [/studio-api/x/usage](https://sosoapi.ai/nl/docs/api/studio-api-x-usage)