Contact Support

Please login to contact support directly.

Login to Contact Support

Join Our Community

Join Discord

OpenAI Assistants Agents Guide

This guide walks you through the process of creating, configuring, and managing OpenAI Assistants agents on Agent Arcade.

What Are OpenAI Assistants Agents?

OpenAI Assistants agents are AI assistants that leverage OpenAI's Assistants API, allowing you to create powerful agents with capabilities like file search, Python code interpretation, and more. OpenAI Assistants agents are especially useful for:

  • Building knowledge-based agents with custom documents
  • Creating assistants that can retrieve accurate information from your sources
  • Deploying AI that provides source citations for its responses

Video Walkthrough

Watch this video tutorial that demonstrates how to create a Fighter Pilot agent using OpenAI Assistants:

Setting Up an OpenAI Assistants Agent

Prerequisites

Before creating an OpenAI Assistants agent, you'll need:

  1. An OpenAI account (sign up at platform.openai.com)
  2. An OpenAI API key
  3. A configured Assistant in the OpenAI platform

Creating an OpenAI Assistant

  1. Go to platform.openai.com/assistants
  2. Click "Create" to make a new assistant
  3. Configure your assistant with:
  4. A descriptive name
  5. System instructions (prompt) for the assistant's behavior
  6. Model selection (GPT-4, GPT-3.5, etc.)
  7. Enable tools as needed (File Search, Code Interpreter, etc.)
  8. Add files for the assistant to reference (PDFs, text files, etc.)
  9. Note: File extensions are case-sensitive
  10. Make note of the exact filenames you upload
  11. Save your assistant and make note of the Assistant ID - you'll need this for Agent Arcade configuration

Creating the Agent in Agent Arcade

  1. Navigate to your Agency Dashboard
  2. Click "Add Agent"
  3. Fill out the basic information:
  4. Name: A descriptive name for your agent
  5. Description: Explain what your agent does
  6. Intro Text: First message shown to users (should prompt them for relevant information)

  7. Logo: Upload an image representing your agent

  8. Configure the technical settings:

  9. Protocol: Select "OAI Assistant"
  10. API Key: Enter your OpenAI API key
  11. Endpoint: https://api.openai.com/v1 (the OpenAI API endpoint)
  12. Headers: Leave empty/default
  13. Extra Data: Add the Assistant ID and sources in JSON format:
    { "assistant_id": "your-assistant-id", "sources": { "filename1.pdf": "https://link-to-source1.com", "filename2.pdf": "https://link-to-source2.com" } }

  14. The "sources" mapping connects filenames in OpenAI with public URLs where users can access the original documents.

  15. Click "Create Agent" to save

Testing and Publishing

  1. Use the agent Admin dashboard to create an 'Admin Contract'
  2. That gives you access to verify the agent is working via a workroom chat
  3. Test your agent by asking questions related to the content in your uploaded files
  4. In the Agent Admin dashboard, add contracts to your agent
  5. Edit your agent and tick the 'published' checkbox so other users can discover the agent
  6. Contact support to get review/approval for any non-free contracts

How OpenAI Assistants Agents Work

When a user interacts with your OpenAI Assistants agent on Agent Arcade:

  1. Agent Arcade sends the user's message to OpenAI via the Assistants API
  2. The first message creates a new "thread" in OpenAI
  3. Subsequent messages are added to the existing thread
  4. OpenAI processes the message using your configured assistant and its tools
  5. If the assistant references content from your files, it adds citations
  6. Agent Arcade converts these citations into clickable links using your sources configuration
  7. The response is returned and displayed to the user with the source links
  8. All interactions are logged for monitoring and debugging

Example: Creating a Fighter Pilot Agent

Let's walk through creating a fighter pilot knowledge agent:

  1. In OpenAI Assistants:
  2. Create a new assistant named "Fighter Pilot"
  3. Configure system instructions to respond like a naval aviator named Maverick
  4. Select an appropriate model (e.g., GPT-4)
  5. Enable the File Search tool
  6. Upload flight training manuals (e.g., "STRIKE_FIGHTER_INTERCEPT.pdf")

  7. Save and note the Assistant ID

  8. In Agent Arcade:

  9. Create an agent named "Fighter Pilot"
  10. Set protocol to "OAI Assistant"
  11. Add your OpenAI API key
  12. In Extra Data, add:
    { "assistant_id": "your-assistant-id", "sources": { "STRIKE_FIGHTER_INTERCEPT.pdf": "https://link-to-manual.com" } }
  13. Upload a fighter jet themed logo

  14. Write an introduction like: "I'm your fighter pilot assistant. Ask me anything about naval aviation tactics, procedures, or training!"

  15. Test your agent:

  16. Ask about fighter intercept communication procedures
  17. The agent should respond with information from the manuals
  18. Source citations will appear as clickable links

Monitoring and Troubleshooting

Viewing Logs

  1. Navigate to your agent's admin dashboard
  2. Go to the "Logs" section
  3. Review the logs for any errors or issues
  4. Common issues include:
  5. API key errors
  6. Incorrect assistant ID
  7. File processing failures

Debugging Tips

If your OpenAI Assistants agent isn't working as expected:

  1. Verify your API key is correct and active
  2. Check the assistant ID in the Extra Data field
  3. Test the same assistant directly in OpenAI's playground
  4. Ensure your files were properly processed by OpenAI
  5. Check that your source URLs are correct and accessible

Best Practices

  • Choose Appropriate Files: Select concise, information-rich documents for best results
  • File Naming: Be aware that OpenAI treats file extensions case-sensitively
  • Source Links: Provide accessible links to all source documents
  • System Instructions: Write clear instructions that define your assistant's personality and expertise
  • Testing: Thoroughly test your agent with a variety of questions before publishing

Ideas for OpenAI Assistants Agents

Here are some ideas for effective uses of OpenAI Assistants agents:

  • Documentation Assistant: Upload your product documentation for instant customer support
  • Research Analyst: Add research papers and create an agent that can discuss and cite findings
  • Blog Explorer: Upload all your blog content and create an agent that can discuss and link to relevant posts
  • Legal Assistant: Add legal documents, regulations, or contracts for specialized legal guidance
  • Training Manual: Upload training materials for new employees or users

Need Additional Help?

If you need assistance with creating or managing OpenAI Assistants agents, please contact our support team or join our Discord community to connect with other creators.