account

Obter conta

Identidade, saldo de créditos e a credencial usada na chamada. Faça esta chamada primeiro: uma única solicitação informa o que esta credencial tem permissão para fazer.

GET/v1/account

Request

curl --request GET \
  --url 'https://api.atelier201.com/v1/account' \
  --header 'Authorization: <api-key>'

import json
import requests

url = "https://api.atelier201.com/v1/account"
headers = {
  "Authorization": "<api-key>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.atelier201.com/v1/account");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.atelier201.com/v1/account", nil)
  req.Header.Set("Authorization", "<api-key>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://api.atelier201.com/v1/account"))
    .header("Authorization", "<api-key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.atelier201.com/v1/account")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "<api-key>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "workspace": {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>"
    },
    "credit_balance": 123,
    "credential": {
      "id": "<string>",
      "kind": "api_key",
      "name": null,
      "prefix": "<string>",
      "scopes": [
        "account:read"
      ],
      "created_at": "<string>",
      "expires_at": null
    },
    "capabilities": {
      "webhooks": true
    }
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

Faça esta chamada primeiro. Ela identifica o workspace e informa o que esta credencial realmente pode fazer, para que você não precise descobrir um limite ao esbarrar nele.

Requer account:read. Não altera nada e não custa créditos. Consulte capabilities para saber se um recurso está disponível, em vez de deduzir isso pelo número da versão. Assim, uma integração criada hoje continua funcionando quando um recurso é lançado.

Autorizações

Authorizationbearerin headerrequired

Resposta

application/json

Recupera o workspace autenticado

dataobjectrequired

Show child attributes

data.workspaceobjectrequired

Show child attributes

data.workspace.idstringrequired

data.workspace.namestringrequired

data.workspace.slugstringrequired

data.credit_balanceintegerrequiredrange: -9007199254740991–9007199254740991

data.credentialobjectrequired

Show child attributes

data.credential.idstringrequired

data.credential.kindenum<string>requiredone of: api_key, oauth

data.credential.namestringnullrequired

data.credential.prefixstringrequired

data.credential.scopesenum<string>[]required

data.credential.created_atstringrequired

data.credential.expires_atstringnullrequired

data.capabilitiesobjectrequired

Show child attributes

data.capabilities.webhooksbooleanrequired

request_idstringrequired

{ "data": { "workspace": { "id": "<string>", "name": "<string>", "slug": "<string>" }, "credit_balance": 123, "credential": { "id": "<string>", "kind": "api_key", "name": null, "prefix": "<string>", "scopes": [ "account:read" ], "created_at": "<string>", "expires_at": null }, "capabilities": { "webhooks": true } }, "request_id": "<string>" }

{ "error": { "type": "<string>", "code": "<string>", "message": "<string>", "param": "<string>", "docs_url": "<string>", "action_url": "<string>", "details": {} }, "request_id": "<string>" }

Obter conta

Autorizações

Resposta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies