View as Markdown
xAI icon

xAI ACTION

Post Chat Completion

Create a language model response for a chat conversation. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's xAI account once, then configure and run Post Chat Completion from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "x_ai-post-chat-completion",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    x_ai: { authProvisionId: "apn_xxxxxxx" },
    model: "Model",
    message: "Message",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Post Chat Completion inputs
Property Type Description
model Model string
ID of the embedding model to use
Required Dynamic
message Message string
Message for the chat completion
Required
frequencyPenalty Frequency Penalty string
Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim
Optional
logprobs Log Probabilities boolean
Include the log probabilities on the logprobs most likely output tokens, as well the chosen tokens
Optional
maxTokens Max Tokens integer
Limits the number of tokens that can be produced in the output
Optional
n Completion Number integer
Determines how many completion sequences to produce for each prompt. Be cautious with its use due to high token consumption
Optional
presencePenalty Presence Penalty string
Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics
Optional
seed Seed integer
If specified, our system will make a best effort to sample deterministically
Optional
stream Stream boolean
Whether to stream back partial progress. If set, tokens will be sent as data-only server-sent events as they become available
Optional
temperature Temperature string
What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic
Optional
topP Nucleus Sampling string
An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered
Optional
user User string
A unique identifier representing your end-user, which can help xAI to monitor and detect abuse
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
x_ai-post-chat-completion
Version
0.0.3
App
xAI
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes