View as Markdown
xAI icon

xAI ACTION

Create Embedding

Create an embedding vector representation corresponding to the input text. 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 Create Embedding 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-create-embeddings",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    x_ai: { authProvisionId: "apn_xxxxxxx" },
    embeddingModel: "Embedding Models",
    input: ["Input"],
  },
})

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.

Create Embedding inputs
Property Type Description
embeddingModel Embedding Models string
ID of the embedding model to use
Required Dynamic
input Input string[]
Text input to be converted into an embedding
Required
dimensions Dimensions integer
The number of dimensions the resulting output embeddings should have
Optional
encodingFormat Encoding Format string
The format to return the embeddings in
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-create-embeddings
Version
0.0.3
App
xAI
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes