ByteChef LogoByteChef

Gamma

Gamma is an AI-powered platform for creating presentations, documents, and social posts from text prompts, outlines, or existing content.

Categories: Artificial Intelligence, Productivity and Collaboration

Type: gamma/v1


Connections

Version: 1

API Key

Properties

NameLabelTypeDescriptionRequired
keyKeySTRINGtrue
valueAPI KeySTRINGTo create an API key go to Settings -> API Keys in Gamma.true

Connection Setup

API keys are available on all Gamma plans. Generations consume workspace credits. If you cannot create a key, ask your workspace admin, who can restrict API key access.

Create API Key

  1. Log in to Gamma.
  2. Go to Settings.
  3. Click on API Keys (or open gamma.app/settings/api-keys directly).
  4. Click on Create API key.
  5. Copy the generated key and paste it into the API Key field of the ByteChef connection.

Actions

Generate Presentation

Name: generatePresentation

Start generating a presentation, document, or social post from text. Generation runs asynchronously; pass the returned generation ID to Get Generation to check its status and get the gamma URL and export URL.

Properties

NameLabelTypeDescriptionRequired
inputTextInput TextSTRINGThe text to generate from: a topic, an outline, or full content.true
textModeText ModeSTRING
Options generate, condense, preserve
How to interpret the input text: generate expands it into new content, condense summarizes it, and preserve keeps it as written.true
formatFormatSTRING
Options presentation, document, social
The output format of the generated gamma.false
themeIdTheme IDSTRINGThe ID of the theme to apply. Uses the workspace default theme when empty.false
numCardsNumber of CardsINTEGERThe target number of cards or slides to generate.false
additionalInstructionsAdditional InstructionsSTRINGAdditional instructions for the AI, for example about tone, layout or content focus.false
exportAsExport AsSTRING
Options pdf, pptx
The file format to export the gamma to after generation. Get Generation returns the download URL as the export URL.false

Example JSON Structure

{
  "label" : "Generate Presentation",
  "name" : "generatePresentation",
  "parameters" : {
    "inputText" : "",
    "textMode" : "",
    "format" : "",
    "themeId" : "",
    "numCards" : 1,
    "additionalInstructions" : "",
    "exportAs" : ""
  },
  "type" : "gamma/v1/generatePresentation"
}

Output

Type: OBJECT

Properties

NameTypeDescription
generationIdSTRINGThe ID of the generation. Pass it to Get Generation.
warningsSTRINGWarnings about the request, for example ignored options.

Output Example

{
  "generationId" : "",
  "warnings" : ""
}

Get Generation

Name: getGeneration

Get the status of a generation. When the status is completed, the result includes the gamma URL and, if an export was requested, the export URL.

Properties

NameLabelTypeDescriptionRequired
generationIdGeneration IDSTRINGThe ID of the generation returned by Generate Presentation.true

Example JSON Structure

{
  "label" : "Get Generation",
  "name" : "getGeneration",
  "parameters" : {
    "generationId" : ""
  },
  "type" : "gamma/v1/getGeneration"
}

Output

Type: OBJECT

Properties

NameTypeDescription
generationIdSTRINGThe ID of the generation.
statusSTRINGThe status of the generation: pending, completed or failed.
gammaIdSTRINGThe ID of the generated gamma, present when the generation is completed.
gammaUrlSTRINGThe URL of the generated gamma, present when the generation is completed.
exportUrlSTRINGThe download URL of the exported file, present when Export As was set and the generation is completed. Anyone with this URL can download the file until it expires.
errorOBJECT
Properties {STRING(message), NUMBER(statusCode)}
The error details, present when the generation failed.
creditsOBJECT
Properties {NUMBER(deducted), NUMBER(remaining)}
The credit usage of the generation.

Output Example

{
  "generationId" : "",
  "status" : "",
  "gammaId" : "",
  "gammaUrl" : "",
  "exportUrl" : "",
  "error" : {
    "message" : "",
    "statusCode" : 0.0
  },
  "credits" : {
    "deducted" : 0.0,
    "remaining" : 0.0
  }
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

How is this guide?

Last updated on

On this page