Claude Platform

https://platform.claude.com/docs/pt-BR
Admin
Claude Platform is an AI development platform by Anthropic that provides APIs, SDKs, and tools to...
Tokens:3,981,308
Snippets:23,177
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Maven: Example output

Source: https://platform.claude.com/docs/pt-BR/get-started

Example output from running the QuickStart program, showing a list of search strategies for renewable energy.

```text
Here are some effective search strategies to find the latest developments in renewable energy:

## General Search Terms
- "Renewable energy news 2025"
- ...
```

--------------------------------

### Get tunnel domain from Secret (kubectl)

Source: https://platform.claude.com/docs/pt-BR/agents-and-tools/mcp-tunnels/deploy-helm

Read the tunnel domain from the `mcp-tunnel` Secret after installation. The setup component stores the tunnel ID and domain in this Secret when `tunnel.id` is empty. Re-running the setup component reuses the stored tunnel ID and never creates a second tunnel.

```bash
kubectl -n mcp-tunnel get secret mcp-tunnel \
  -o jsonpath='{.data.tunnel-domain}' | base64 -d
```

--------------------------------

### Python: Criar quickstart.py

Source: https://platform.claude.com/docs/pt-BR/get-started

Cria o arquivo `quickstart.py` para o código do exemplo (o conteúdo não é exibido na página).

```text
Crie um arquivo chamado `quickstart.py`:

```

--------------------------------

### Install MCP tunnel Helm chart (helm install)

Source: https://platform.claude.com/docs/pt-BR/agents-and-tools/mcp-tunnels/deploy-helm

Install the MCP tunnel Helm chart with the specified version and values file. The setup component runs as a Helm pre-install hook Job, so `helm install` blocks until it completes; on success the Job is deleted automatically. If `helm install` fails with a hook error, see the troubleshooting section on setup component authentication failures.

```bash
helm install mcp-tunnel \
  oci://us-docker.pkg.dev/anthropic-public-registry/charts/mcp-tunnel \
  --version 2.0.2 \
  --namespace mcp-tunnel --create-namespace \
  -f values.yaml
```

--------------------------------

### PHP: Run quickstart.php

Source: https://platform.claude.com/docs/pt-BR/get-started

Executes the PHP quickstart script.

```bash
php quickstart.php
```

--------------------------------

### Install Java AWS SDK (Gradle and Maven)

Source: https://platform.claude.com/docs/pt-BR/build-with-claude/claude-platform-on-aws

Install the Anthropic Java AWS SDK using Gradle or Maven. The Gradle example uses Kotlin DSL, and the Maven example uses XML.

```kotlin
implementation("com.anthropic:anthropic-java-aws:2.58.0")
```

```xml
<dependency>
  <groupId>com.anthropic</groupId>
  <artifactId>anthropic-java-aws</artifactId>
  <version>2.58.0</version>
</dependency>
```

--------------------------------

### Java: Create QuickStart.java

Source: https://platform.claude.com/docs/pt-BR/get-started

Defines the main Java class for the quickstart. It uses the Anthropic Java SDK to send a message and print the response. Requires the SDK and Java 25.

```java
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.messages.Message;
import com.anthropic.models.messages.MessageCreateParams;
import com.anthropic.models.messages.Model;

static void main() {
    var client = AnthropicOkHttpClient.fromEnv();

    var params = MessageCreateParams.builder()
        .model(Model.CLAUDE_OPUS_5)
        .maxTokens(1000)
        .addUserMessage(
            "What should I search for to find the latest developments in renewable energy?"
        )
        .build();

    Message message = client.messages().create(params);
    for (var block : message.content()) {
        block.text().ifPresent(textBlock -> IO.println(textBlock.text()));
    }
}
```

--------------------------------

### Quick start: Create ClaudeLanguageModel and get a response

Source: https://platform.claude.com/docs/pt-BR/cli-sdks-libraries/libraries/apple-foundation-models#authentication

Create a ClaudeLanguageModel with an API key from the environment, start a session, and get a response. The model name is .sonnet5 and the API key is read from the ANTHROPIC_API_KEY environment variable.

```swift
import FoundationModels
import ClaudeForFoundationModels

let model = ClaudeLanguageModel(
  name: .sonnet5,
  auth: .apiKey(ProcessInfo.processInfo.environment["ANTHROPIC_API_KEY"] ?? "")
)

let session = LanguageModelSession(model: model)
let response = try await session.respond(to: "Plan a 4-day trip to Buenos Aires.")
print(response.content)
```

--------------------------------

### Ruby: Run quickstart.rb

Source: https://platform.claude.com/docs/pt-BR/get-started

Executes the Ruby quickstart script using bundle exec.

```bash
bundle exec ruby quickstart.rb
```

--------------------------------

### Response 200 Example for Get Connector Usage

Source: https://platform.claude.com/docs/pt-BR/api/beta/organization/analytics/connectors/list

Example response for the GET /v1/organizations/analytics/connectors endpoint. Shows the structure of the BetaConnectorUsage object with metrics for chat, Claude Code, cowork, and Office products, plus user and RBAC fields.

```json
{
  "data": [
    {
      "chat_metrics": {
        "distinct_conversation_connector_used_count": 0
      },
      "claude_code_metrics": {
        "distinct_session_connector_used_count": 0
      },
      "connector_name": "connector_name",
      "cowork_metrics": {
        "distinct_session_connector_used_count": 0
      },
      "distinct_user_count": 0,
      "office_metrics": {
        "excel": {
          "distinct_session_connector_used_count": 0
        },
        "outlook": {
          "distinct_session_connector_used_count": 0
        },
        "powerpoint": {
          "distinct_session_connector_used_count": 0
        },
        "word": {
          "distinct_session_connector_used_count": 0
        }
      },
      "connector_display_name": "connector_display_name",
      "individual_auth_distinct_user_count": 0,
      "managed_auth_distinct_user_count": 0,
      "product": "product",
      "rbac_group_id": "rbac_group_id",
      "rbac_group_name": "rbac_group_name",
      "read_call_count": 0,
      "unclassified_call_count": 0,
      "user_id": "user_id",
      "write_call_count": 0
    }
  ],
  "next_page": "next_page"
}
```

--------------------------------

### Bad Example: Assumes Installation

Source: https://platform.claude.com/docs/pt-BR/agents-and-tools/agent-skills/best-practices

Shows an incorrect approach where the skill assumes a package is installed without specifying dependencies.

```markdown
"Use the pdf library to process the file."
```

--------------------------------

### Maven: Compile and run QuickStart

Source: https://platform.claude.com/docs/pt-BR/get-started

Runs the QuickStart main class using Maven's exec plugin. This command compiles the project and executes the specified main class.

```bash
mvn compile exec:java -Dexec.mainClass=QuickStart
```

--------------------------------

### PHP: Create quickstart.php

Source: https://platform.claude.com/docs/pt-BR/get-started

Creates a PHP script that sends a message to the Claude model and prints the text response.

```php
<?php
require 'vendor/autoload.php';

use Anthropic\Client;
use Anthropic\Messages\Model;
use Anthropic\Messages\TextBlock;

$client = new Client();

$message = $client->messages->create(
    model: Model::CLAUDE_OPUS_5,
    maxTokens: 1000,
    messages: [
        [
            'role' => 'user',
            'content' => 'What should I search for to find the latest developments in renewable energy?',
        ],
    ],
);

foreach ($message->content as $block) {
    if ($block instanceof TextBlock) {
        echo $block->text . PHP_EOL;
    }
}
```

--------------------------------

### Response 200 example for get project details

Source: https://platform.claude.com/docs/pt-BR/api/compliance/apps/projects/retrieve

Example successful response (HTTP 200) from the GET /v1/compliance/apps/projects/{project_id} endpoint. Shows the project object with fields such as id, attachments_count, chats_count, created_at, deleted_at, description, instructions, is_private, name, organization_id, organization_uuid, updated_at, and user.

```json
{
  "id": "claude_proj_01Nm7PqRsTuVwXyZaBcDeFgH",
  "attachments_count": 3,
  "chats_count": 14,
  "created_at": "2025-03-12T18:22:41.123456Z",
  "deleted_at": "2019-12-27T18:11:19.117Z",
  "description": "Planning and research for the Q3 launch",
  "instructions": "Focus on concise, actionable answers.",
  "is_private": true,
  "name": "Q3 Product Launch",
  "organization_id": "org_015eofRkKpogX7uDKUyvBTph",
  "organization_uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
  "updated_at": "2025-03-14T09:05:17.456789Z",
  "user": {
    "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
    "email_address": "jane.doe@example.com"
  }
}
```

--------------------------------

### Executar o exemplo Python

Source: https://platform.claude.com/docs/pt-BR/get-started

Executa o arquivo quickstart.py que contém o código de exemplo Python. A saída esperada é uma lista de estratégias de busca para encontrar desenvolvimentos recentes em energia renovável.

```bash
python quickstart.py
```

```text
Here are some effective search strategies to find the latest developments in renewable energy:

## General Search Terms
- "Renewable energy news 2025"
- ...
```

--------------------------------

### Java: Create project directory

Source: https://platform.claude.com/docs/pt-BR/get-started

Creates the directory structure for a Java quickstart project. Requires JDK 25 or later and Gradle or Maven on the PATH.

```bash
mkdir -p claude-quickstart/src/main/java && cd claude-quickstart
```

--------------------------------

### cURL request for Get Artifact Activity

Source: https://platform.claude.com/docs/pt-BR/api/beta/organization/analytics/artifacts/list

Sends a GET request to /v1/organizations/analytics/artifacts with the required anthropic-version header and API key. No query parameters are included in this example.

```bash
curl https://api.anthropic.com/v1/organizations/analytics/artifacts \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"
```

--------------------------------

### Response 200 for get current organization

Source: https://platform.claude.com/docs/pt-BR/api/admin-api/organization/get-me

Example successful response from the GET /v1/organizations/me endpoint, showing the organization object with id, name, and type fields.

```json
{
  "id": "12345678-1234-5678-1234-567812345678",
  "name": "Organization Name",
  "type": "organization"
}
```

--------------------------------

### Ruby: Create project and install SDK

Source: https://platform.claude.com/docs/pt-BR/get-started

Creates a new directory, initializes a Ruby bundle, and adds the anthropic gem.

```bash
mkdir claude-quickstart && cd claude-quickstart
bundle init
bundle add anthropic
```

--------------------------------

### Ruby: Create quickstart.rb

Source: https://platform.claude.com/docs/pt-BR/get-started

Creates a Ruby script that sends a message to the Claude model and prints the text response.

```ruby
require "anthropic"

client = Anthropic::Client.new

message = client.messages.create(
  model: Anthropic::Model::CLAUDE_OPUS_5,
  max_tokens: 1000,
  messages: [
    {
      role: "user",
      content: "What should I search for to find the latest developments in renewable energy?"
    }
  ]
)

message.content.each do |block|
  puts block.text if block.type == :text
end
```

--------------------------------

### GET /v1/organizations/analytics/plugins

Source: https://platform.claude.com/docs/pt-BR/api/admin/analytics

Retrieves per-plugin install and invocation usage for a given day, with pagination.

```APIDOC
## GET /v1/organizations/analytics/plugins

### Description
Get per-plugin install + invocation usage for a given day, with pagination.

### Method
GET

### Endpoint
/v1/organizations/analytics/plugins

### Parameters
#### Query Parameters
- **date** (string) - Required - The day for which to retrieve usage.
- **cursor** (string) - Optional - Cursor for pagination.

### Response
#### Success Response (200)
- **plugins** (array) - List of plugin usage objects.
- **next_cursor** (string) - Cursor for the next page.

#### Response Example
{
  "plugins": [
    {
      "plugin_id": "plugin_123",
      "install_count": 2,
      "invocation_count": 10
    }
  ],
  "next_cursor": "cursor_abc"
}
```

--------------------------------

### Good Example: Explicit about Dependencies

Source: https://platform.claude.com/docs/pt-BR/agents-and-tools/agent-skills/best-practices

Shows the correct approach: explicitly state the required package installation command and then use it in code. This example uses pypdf to read a PDF file.

```markdown
"Install required package: `pip install pypdf`

Then use it:
```python
from pypdf import PdfReader
reader = PdfReader("file.pdf")
```"
```

--------------------------------

### Configurar cliente com fromEnv()

Source: https://platform.claude.com/docs/pt-BR/cli-sdks-libraries/sdks/java

Configura o cliente usando propriedades do sistema ou variáveis de ambiente. As propriedades do sistema têm precedência sobre as variáveis de ambiente.

```java
import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;

// Configura usando as propriedades de sistema `anthropic.apiKey`, `anthropic.authToken` e `anthropic.baseUrl`
// Ou configura usando as variáveis de ambiente `ANTHROPIC_API_KEY`, `ANTHROPIC_AUTH_TOKEN` e `ANTHROPIC_BASE_URL`
AnthropicClient client = AnthropicOkHttpClient.fromEnv();
```

--------------------------------

### GET /v1/organizations/rbac_groups/{group_id}

Source: https://platform.claude.com/docs/pt-BR/api/http/beta/organization/rbac_groups/retrieve

This snippet documents the GET endpoint to retrieve an RBAC Group by its ID. It includes the path parameter, request example, and the full response schema with a sample response.

```APIDOC
## GET /v1/organizations/rbac_groups/{group_id}

### Description
Retrieve an RBAC Group by ID. The RBAC Groups API is available to Claude Enterprise organizations only.

### Method
GET

### Endpoint
/v1/organizations/rbac_groups/{group_id}

### Parameters
#### Path Parameters
- **group_id** (string) - Required - ID of the RBAC Group.

### Request Example
```
curl https://api.anthropic.com/v1/organizations/rbac_groups/$GROUP_ID \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"
```

### Response
#### Success Response (200)
- **type** (string) - Object type. For RBAC Groups, this is always `"rbac_group"`.
- **id** (string) - ID of the RBAC Group.
- **created_at** (string) - RFC 3339 timestamp of when the RBAC Group was created.
- **name** (string) - Name of the RBAC Group. Not uniqueness-enforced.
- **roles** (array of string or null) - RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list.
- **source_type** (string) - How the RBAC Group was created: `"direct"` for groups created directly (for example, in the organization's admin settings), `"scim"` for groups provisioned by the identity provider.
- **updated_at** (string) - RFC 3339 timestamp of when the RBAC Group was last updated.

#### Response Example
```
{
  "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "name": "Engineering",
  "roles": [
    "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
  ],
  "source_type": "direct",
  "type": "rbac_group",
  "updated_at": "2024-10-30T23:58:27.427722Z"
}
```
```

--------------------------------

### Install Go SDK (workaround)

Source: https://platform.claude.com/docs/pt-BR/build-with-claude/claude-in-microsoft-foundry

Install the standard Go SDK as a workaround since Foundry is not natively supported.

```bash
# O SDK Go ainda não oferece suporte nativo ao Foundry (consulte os exemplos de
# Autenticação para usar o SDK Go padrão como solução alternativa)
go get github.com/anthropics/anthropic-sdk-go
```

--------------------------------

### GET /v1/organizations/workspaces/{workspace_id}/rate_limits

Source: https://platform.claude.com/docs/pt-BR/api/admin/workspaces/rate_limits/list

This snippet documents the GET endpoint for listing workspace rate limit overrides, including path and query parameters, request example, and response schema.

```APIDOC
## GET /v1/organizations/workspaces/{workspace_id}/rate_limits

### Description
List the rate limit overrides configured for a workspace. Returns only the groups and limiter types that have an override at the workspace level. Groups without overrides inherit the organization limits and are not listed; use `GET /v1/organizations/rate_limits` to see them.

### Method
GET

### Endpoint
/v1/organizations/workspaces/{workspace_id}/rate_limits

### Parameters
#### Path Parameters
- **workspace_id** (string) - Required - The ID of the workspace.

#### Query Parameters
- **group_type** (string) - Optional - Filter by group type. One of: "batch", "files", "model_group", "skills", "token_count", "web_search".
- **limit** (number) - Optional - Maximum number of items to return per page. Ranges from `1` to `1000`. When omitted, every remaining entry is returned in a single page and `next_page` is `null`.
- **page** (string) - Optional - Opaque cursor from a previous response's `next_page`.

### Request Example
```
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"
```

### Response
#### Success Response (200)
- **data** (array of BetaWorkspaceRateLimit) - Rate-limit entries for the workspace, one per group that has at least one override.
  - **type** (string) - Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
  - **group_type** (string) - The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. One of: "batch", "files", "model_group", "skills", "token_count", "web_search".
  - **limits** (array of BetaWorkspaceRateLimitValue) - The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.
    - **type** (string) - The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
    - **org_limit** (number or null) - The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
    - **value** (number) - The workspace-level override value for this limiter type.
  - **models** (array of string or null) - Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.
  - **rate_limit_id** (string) - The `id` of the RateLimit group this override applies to.
  - **workspace_id** (string) - ID of the Workspace this override applies to.
- **next_page** (string or null) - Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.

#### Response Example
```
{
  "data": [
    {
      "group_type": "batch",
      "limits": [
        {
          "org_limit": 0,
          "type": "type",
          "value": 0
        }
      ],
      "models": [
        "string"
      ],
      "rate_limit_id": "rate_limit_id",
      "type": "workspace_rate_limit",
      "workspace_id": "workspace_id"
    }
  ],
  "next_page": "next_page"
}
```
```

--------------------------------

### Progress notes example (progress.txt)

Source: https://platform.claude.com/docs/pt-BR/build-with-claude/prompt-engineering/claude-prompting-best-practices

Unstructured text format for tracking progress across sessions, including notes on fixes and next steps.

```text
// Progress notes (progress.txt)
Session 3 progress:
- Fixed authentication token validation
- Updated user model to handle edge cases
- Next: investigate user_management test failures (test #2)
- Note: Do not remove tests as this could lead to missing functionality
```
Tokens:
Raw