Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt

Use this file to discover all available pages before exploring further.

Server path: /anthropic | Type: Application | PCID required: Yes

Tools

ToolDescription
anthropic_analyze_imageDEPRECATED — Analyze an image using Claude vision capabilities. Use anthropic_create_message with image content blocks instead.
anthropic_batch_messagesDEPRECATED — Process multiple messages sequentially. Use anthropic_create_message_batch for proper async batch processing instead.
anthropic_cancel_message_batchCancel a Message Batch
anthropic_count_tokensCount tokens in a Message
anthropic_create_messageCreate a Message
anthropic_create_message_batchCreate a Message Batch
anthropic_create_skillCreate Skill
anthropic_create_skill_versionCreate Skill Version
anthropic_delete_fileDelete File
anthropic_delete_message_batchDelete a Message Batch
anthropic_delete_skillDelete Skill
anthropic_delete_skill_versionDelete Skill Version
anthropic_download_fileDownload File
anthropic_get_fileGet File Metadata
anthropic_get_message_batchRetrieve a Message Batch
anthropic_get_message_batch_resultsRetrieve Message Batch results
anthropic_get_modelGet a Model
anthropic_get_skillGet Skill
anthropic_get_skill_versionGet Skill Version
anthropic_list_filesList Files
anthropic_list_message_batchesList Message Batches
anthropic_list_modelsList Models
anthropic_list_skill_versionsList Skill Versions
anthropic_list_skillsList Skills
anthropic_upload_fileUpload File

anthropic_analyze_image

DEPRECATED — Analyze an image using Claude vision capabilities. Use anthropic_create_message with image content blocks instead. Parameters:
ParameterTypeRequiredDefaultDescription
modelstringNoClaude model with vision capabilities (e.g., claude-sonnet-4-5-20250929)
imageUrlstringNoURL of image to analyze
imageBase64stringNoBase64 encoded image data
promptstringYesQuestion or instruction about the image
maxTokensintegerNoMaximum tokens to generate

anthropic_batch_messages

DEPRECATED — Process multiple messages sequentially. Use anthropic_create_message_batch for proper async batch processing instead. Parameters:
ParameterTypeRequiredDefaultDescription
modelstringYesClaude model to use (e.g., claude-sonnet-4-5-20250929)
requestsobject[]YesArray of message requests to process sequentially
temperaturenumberNoSampling temperature (0-1)

anthropic_cancel_message_batch

Cancel a Message Batch Parameters:
ParameterTypeRequiredDefaultDescription
message_batch_idstringYesID of the Message Batch.

anthropic_count_tokens

Count tokens in a Message Parameters:
ParameterTypeRequiredDefaultDescription
cache_controlobjectNoTop-level cache control automatically applies a cache_control marker to the last cacheable block in the request.
messagesobject[]YesInput messages. Our models are trained to operate on alternating user and assistant conversational turns. When creating a new Message, you specify the prior conversational turns with the messages parameter, and the model then generates the next Message in the conversation. Consecutive user or assistant turns in your request will be combined into a single turn. Each input message must be an object with a role and content. You can specify a single user-role message, or you can include multiple user and assistant messages. If the final message uses the assistant role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model’s response. Example with a single user message: json [{"role": "user", "content": "Hello, Claude"}] Example with multiple conversational turns: json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] Example with a partially-filled response from Claude: json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] Each input message content may be either a single string or an array of content blocks, where each block has a specific type. Using a string for content is shorthand for an array of one content block of type "text". The following input messages are equivalent: json {"role": "user", "content": "Hello, Claude"} json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} See input examples. Note that if you want to include a system prompt, you can use the top-level system parameter — there is no "system" role for input messages in the Messages API. There is a limit of 100,000 messages in a single request.
modelobjectYesThe model that will complete your prompt.\n\nSee models for additional details and options.
output_configobjectNoOutput Config
systemobjectNoSystem prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our guide to system prompts.
thinkingobjectNoConfiguration for enabling Claude’s extended thinking. When enabled, responses include thinking content blocks showing Claude’s thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your max_tokens limit. See extended thinking for details.
tool_choiceobjectNoHow the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all.
toolsany[]NoDefinitions of tools that the model may use. If you include tools in your API request, the model may return tool_use content blocks that represent the model’s use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using tool_result content blocks. There are two types of tools: client tools and server tools. The behavior described below applies to client tools. For server tools, see their individual documentation as each has its own behavior (e.g., the web search tool). Each tool definition includes: * name: Name of the tool. * description: Optional, but strongly-recommended description of the tool. * input_schema: JSON schema for the tool input shape that the model will produce in tool_use output content blocks. For example, if you defined tools as: json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] And then asked the model “What’s the S&P 500 at today?”, the model might produce tool_use content blocks in the response like this: json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] You might then run your get_stock_price tool with {"ticker": "^GSPC"} as an input, and return the following back to the model in a subsequent user message: json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our guide for more details.

anthropic_create_message

Create a Message Parameters:
ParameterTypeRequiredDefaultDescription
cache_controlobjectNoTop-level cache control automatically applies a cache_control marker to the last cacheable block in the request.
containerstringNoContainer identifier for reuse across requests.
inference_geostringNoSpecifies the geographic region for inference processing. If not specified, the workspace’s default_inference_geo is used.
max_tokensintegerYesThe maximum number of tokens to generate before stopping. Note that our models may stop before reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. Different models have different maximum values for this parameter. See models for details.
messagesobject[]YesInput messages. Our models are trained to operate on alternating user and assistant conversational turns. When creating a new Message, you specify the prior conversational turns with the messages parameter, and the model then generates the next Message in the conversation. Consecutive user or assistant turns in your request will be combined into a single turn. Each input message must be an object with a role and content. You can specify a single user-role message, or you can include multiple user and assistant messages. If the final message uses the assistant role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model’s response. Example with a single user message: json [{"role": "user", "content": "Hello, Claude"}] Example with multiple conversational turns: json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] Example with a partially-filled response from Claude: json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] Each input message content may be either a single string or an array of content blocks, where each block has a specific type. Using a string for content is shorthand for an array of one content block of type "text". The following input messages are equivalent: json {"role": "user", "content": "Hello, Claude"} json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} See input examples. Note that if you want to include a system prompt, you can use the top-level system parameter — there is no "system" role for input messages in the Messages API. There is a limit of 100,000 messages in a single request.
metadataobjectNoThe metadata value
modelobjectYesThe model that will complete your prompt.\n\nSee models for additional details and options.
output_configobjectNoOutput Config
service_tierstringNoDetermines whether to use priority capacity (if available) or standard capacity for this request. Anthropic offers different levels of service for your API requests. See service-tiers for details.
stop_sequencesstring[]NoCustom text sequences that will cause the model to stop generating. Our models will normally stop when they have naturally completed their turn, which will result in a response stop_reason of "end_turn". If you want the model to stop generating when it encounters custom strings of text, you can use the stop_sequences parameter. If the model encounters one of the custom sequences, the response stop_reason value will be "stop_sequence" and the response stop_sequence value will contain the matched stop sequence.
streambooleanNoWhether to incrementally stream the response using server-sent events. See streaming for details.
systemobjectNoSystem prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our guide to system prompts.
temperaturenumberNoAmount of randomness injected into the response. Defaults to 1.0. Ranges from 0.0 to 1.0. Use temperature closer to 0.0 for analytical / multiple choice, and closer to 1.0 for creative and generative tasks. Note that even with temperature of 0.0, the results will not be fully deterministic.
thinkingobjectNoConfiguration for enabling Claude’s extended thinking. When enabled, responses include thinking content blocks showing Claude’s thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your max_tokens limit. See extended thinking for details.
tool_choiceobjectNoHow the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all.
toolsany[]NoDefinitions of tools that the model may use. If you include tools in your API request, the model may return tool_use content blocks that represent the model’s use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using tool_result content blocks. There are two types of tools: client tools and server tools. The behavior described below applies to client tools. For server tools, see their individual documentation as each has its own behavior (e.g., the web search tool). Each tool definition includes: * name: Name of the tool. * description: Optional, but strongly-recommended description of the tool. * input_schema: JSON schema for the tool input shape that the model will produce in tool_use output content blocks. For example, if you defined tools as: json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] And then asked the model “What’s the S&P 500 at today?”, the model might produce tool_use content blocks in the response like this: json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] You might then run your get_stock_price tool with {"ticker": "^GSPC"} as an input, and return the following back to the model in a subsequent user message: json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our guide for more details.
top_kintegerNoOnly sample from the top K options for each subsequent token. Used to remove “long tail” low probability responses. Learn more technical details here. Recommended for advanced use cases only. You usually only need to use temperature.
top_pnumberNoUse nucleus sampling. In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by top_p. You should either alter temperature or top_p, but not both. Recommended for advanced use cases only. You usually only need to use temperature.

anthropic_create_message_batch

Create a Message Batch Parameters:
ParameterTypeRequiredDefaultDescription
requestsobject[]YesList of requests for prompt completion. Each is an individual request to create a Message.

anthropic_create_skill

Create Skill Parameters:
ParameterTypeRequiredDefaultDescription
display_titlestringNoDisplay title for the skill. This is a human-readable label that is not included in the prompt sent to the model.
filesstring[]NoFiles to upload for the skill. All files must be in the same top-level directory and must include a SKILL.md file at the root of that directory.

anthropic_create_skill_version

Create Skill Version Parameters:
ParameterTypeRequiredDefaultDescription
skill_idstringYesUnique identifier for the skill. The format and length of IDs may change over time.
filesstring[]NoFiles to upload for the skill. All files must be in the same top-level directory and must include a SKILL.md file at the root of that directory.

anthropic_delete_file

Delete File Parameters:
ParameterTypeRequiredDefaultDescription
file_idstringYesID of the File.

anthropic_delete_message_batch

Delete a Message Batch Parameters:
ParameterTypeRequiredDefaultDescription
message_batch_idstringYesID of the Message Batch.

anthropic_delete_skill

Delete Skill Parameters:
ParameterTypeRequiredDefaultDescription
skill_idstringYesUnique identifier for the skill. The format and length of IDs may change over time.

anthropic_delete_skill_version

Delete Skill Version Parameters:
ParameterTypeRequiredDefaultDescription
skill_idstringYesUnique identifier for the skill. The format and length of IDs may change over time.
versionstringYesVersion identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., “1759178010641129”).

anthropic_download_file

Download File Parameters:
ParameterTypeRequiredDefaultDescription
file_idstringYesID of the File.

anthropic_get_file

Get File Metadata Parameters:
ParameterTypeRequiredDefaultDescription
file_idstringYesID of the File.

anthropic_get_message_batch

Retrieve a Message Batch Parameters:
ParameterTypeRequiredDefaultDescription
message_batch_idstringYesID of the Message Batch.

anthropic_get_message_batch_results

Retrieve Message Batch results Parameters:
ParameterTypeRequiredDefaultDescription
message_batch_idstringYesID of the Message Batch.

anthropic_get_model

Get a Model Parameters:
ParameterTypeRequiredDefaultDescription
model_idstringYesModel identifier or alias.

anthropic_get_skill

Get Skill Parameters:
ParameterTypeRequiredDefaultDescription
skill_idstringYesUnique identifier for the skill. The format and length of IDs may change over time.

anthropic_get_skill_version

Get Skill Version Parameters:
ParameterTypeRequiredDefaultDescription
skill_idstringYesUnique identifier for the skill. The format and length of IDs may change over time.
versionstringYesVersion identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., “1759178010641129”).

anthropic_list_files

List Files Parameters:
ParameterTypeRequiredDefaultDescription
before_idstringNoID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
after_idstringNoID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
limitintegerNoNumber of items to return per page. Defaults to 20. Ranges from 1 to 1000.

anthropic_list_message_batches

List Message Batches Parameters:
ParameterTypeRequiredDefaultDescription
before_idstringNoID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
after_idstringNoID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
limitintegerNoNumber of items to return per page. Defaults to 20. Ranges from 1 to 1000.

anthropic_list_models

List Models Parameters:
ParameterTypeRequiredDefaultDescription
before_idstringNoID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
after_idstringNoID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
limitintegerNoNumber of items to return per page. Defaults to 20. Ranges from 1 to 1000.

anthropic_list_skill_versions

List Skill Versions Parameters:
ParameterTypeRequiredDefaultDescription
skill_idstringYesUnique identifier for the skill. The format and length of IDs may change over time.
pagestringNoOptionally set to the next_page token from the previous response.
limitintegerNoNumber of items to return per page. Defaults to 20. Ranges from 1 to 1000.

anthropic_list_skills

List Skills Parameters:
ParameterTypeRequiredDefaultDescription
pagestringNoPagination token for fetching a specific page of results. Pass the value from a previous response’s next_page field to get the next page of results.
limitintegerNoNumber of results to return per page. Maximum value is 100. Defaults to 20.
sourcestringNoFilter skills by source. If provided, only skills from the specified source will be returned: * "custom": only return user-created skills * "anthropic": only return Anthropic-created skills

anthropic_upload_file

Upload File Parameters:
ParameterTypeRequiredDefaultDescription
filestringYesThe file to upload