Quickstart

Get up and running with Script Network in just a few steps.

1. Create an Account

Sign up for a free Script Network account. The Starter plan includes up to 100 annotations per month at no cost.

2. Get Your API Key

Navigate to your dashboard settings to generate an API key. You'll need this to authenticate API requests.

export SCRIPT_NETWORK_API_KEY="your-api-key-here"

3. Install the SDK

Install the official SDK for your language of choice:

# Python

pip install scriptnetwork

# JavaScript / TypeScript

npm install @scriptnetwork/sdk

# Go

go get github.com/scriptnetwork/sdk-go

4. Create Your First Project

Initialize a client and create a new annotation project:

from scriptnetwork import Client

client = Client(api_key="your-api-key")

project = client.projects.create(
    name="My First Dataset",
    annotation_type="object_detection",
    export_format="coco_json"
)

print(f"Project created: {project.id}")

5. Upload Data

Upload your images or videos for annotation:

# Upload a batch of images
batch = client.batches.create(
    project_id=project.id,
    files=["image1.jpg", "image2.jpg", "image3.jpg"],
    priority="standard"
)

print(f"Batch {batch.id} uploaded with {batch.file_count} files")

6. Download Results

Once annotation is complete, download your certified dataset:

# Check batch status
batch = client.batches.get(batch.id)
print(f"Status: {batch.status}, Quality: {batch.quality_score}")

# Download certified results
if batch.status == "certified":
    client.batches.download(
        batch_id=batch.id,
        output_path="./dataset/annotations.json"
    )

Next Steps

  • Explore the API Reference for all available endpoints
  • Set up Webhooks for real-time status updates
  • Review Security best practices for API key management