Skip to main content

Quickstart

Set up your environment, learn the platform and create your first agent, pronto.

Request API keys​

Request an API key by signing up for our waitlist. You will set your login credentials as part of sign-up.

We will email you once your account is unlocked, after which you will be able to find your API key on the dashboard.

Try the demo agent in 5 minutes​

The demo agent uses a JSON configuration file to give a brief walkthrough of the AgentStation platform over Zoom. You can view the JSON configuration file in our examples.

The demo agent will:

  • Create a Zoom meeting and provide you with the URL to join
  • Share its screen, and walk through the dashboard and documentation in real-time
  • Answer any questions you have on the platform

You can start the demo agent by clicking 'Start Demo Session' from the dashboard:

AgentStation Dashboard

Create a simple meeting recording agent​

Now that you've seen what's possible on the AgentStation platform, let's create your first agent. This agent will join and record a Zoom meeting you've created.

Via the API​

Step 1: Start a Zoom Meeting

Create a Zoom meeting, then copy the invite link.

Step 2: Request an Agent workstation

Use the Request workstation endpoint to partition your first agent and have it join your meeting.

  • Swap the placeholder in Authorization with your API key
  • Swap the placeholder in meeting_url with the Zoom URL from the previous step.
curl -X POST https://api.agentstation.ai/v1/agent \
    -H 'Authorization: Token {{YOUR-TOKEN-HERE}}' \
    -H 'Content-Type: application/json' \
    -d '{"meeting_url": "{{MEETING-URL-HERE}}"}'

You will receive a response with a session ID. You will need this to retrieve the recording once the meeting ends:

{
  "id": "789c1234-f56g-12d3-a456-426614174000",
  "agentId": "009c5634-y23d-12d3-a456-037614283000",
  "sessionId": "789c0075-v88v-98f7-a456-426618874000",
  "startedAt": "2021-04-07T10:30:00Z",
  "status": "active",
  "meetingUrl": "{{YOUR-MEETING-URL}}",
  "files": []
}

Your agent should join the meeting in a few seconds.

Step 3: Say Hello!

The agent will be recording audio and video, so wave at the camera and say something to test it out.

Step 4: Leave the meeting

Once you leave the meeting, the agent will end its session and stop recording.

Step 5: View session details and get recording link

Use the Retrieve Session endpoint:

  • Swap the placeholder in Authorization with your API key
  • Swap the placeholder in the endpoint URL (YOUR-SESSION-ID) with the session ID from your first request.
curl -L -X GET 'https://api.agentstation.ai/v1/sessions/{{YOUR-SESSION-ID}}' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {{YOUR-TOKEN-HERE}}' \

You will receive a response that contains details on the completed session, along with URLs for all files generated. An audio recording, video recording, and transcript are automatically generated for every workstation session. The transcript may take up to 5 minutes to populate, so you may only see the audio and video recording at first.

{
  "id": "789c1234-f56g-12d3-a456-426614174000",
  "agentId": "009c5634-y23d-12d3-a456-037614283000",
  "sessionId": "789c0075-v88v-98f7-a456-426618874000",
  "startedAt": "2021-04-07T10:30:00Z",
  "status": "active",
  "meetingUrl": "https://zoom.us/j/1234567890",
  "files": [
    {
      "id": "abcde12345-f56g-12d3-a456-426614174000",
      "name": "2024-06-04_03-27-07_UTC_transcript.vtt",
      "type": "text/plain",
      "createdAt": "2021-04-07T11:30:00Z",
      "filePath": "https://api.agentstation.com/files/39dj394hl29hf/3932dllsh2"
    },
    {
      "id": "abcde12345-f56g-12d3-a456-426614174000",
      "name": "2024-06-04_03-27-07_UTC_audio.wav",
      "type": "audio/wave",
      "createdAt": "2021-04-07T11:30:00Z",
      "filePath": "https://api.agentstation.com/files/39dj394hl29hf/3932dllsh2"
    },
    {
      "id": "abcde12345-f56g-12d3-a456-426614174000",
      "name": "2024-06-04_03-27-07_UTC_video.mp4",
      "type": "video/mp4",
      "createdAt": "2021-04-07T11:30:00Z",
      "filePath": "https://api.agentstation.com/files/39dj394hl29hf/3932dllsh2"
    }
  ]
}